{"swagger":"2.0","info":{"version":"2.0.1","title":"Storecove API","description":"Storecove API","contact":{"email":"apisupport@storecove.nl"}},"schemes":["https"],"host":"api.storecove.com","basePath":"/api/v2","tags":[{"name":"InvoiceSubmissions"},{"name":"DocumentSubmissions"},{"name":"LegalEntities"},{"name":"PeppolIdentifiers"},{"name":"Administrations"},{"name":"ReceivedDocuments"},{"name":"AdditionalTaxIdentifiers"},{"name":"PurchaseInvoices"},{"name":"WebhookInstances"},{"name":"Discovery"},{"name":"C5Activation"}],"securityDefinitions":{"Bearer":{"type":"apiKey","name":"Authorization","in":"header"}},"security":[{"Bearer":[]}],"consumes":["application/json"],"produces":["application/json"],"paths":{"/invoice_submissions/{guid}/evidence":{"get":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/InvoiceSubmissionEvidence"}}},"summary":"DEPRECATED. Get InvoiceSubmission Evidence","description":"Deprecated. Use the new /document_submissions/{guid}/evidence endpoint. Get evidence for an InvoiceSubmission by GUID with corresponding status","operationId":"show_invoice_submission_evidence","tags":["InvoiceSubmissions"],"consumes":["application/json"],"parameters":[{"name":"guid","in":"path","description":"InvoiceSubmission GUID","required":true,"type":"string","format":"uuid"}]}},"/invoice_submissions":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"}}},"200":{"description":"Success","schema":{"$ref":"#/definitions/InvoiceSubmissionResult"}}},"summary":"DEPRECATED. Submit a new invoice","description":"DEPRECATED. Use the new /document_submissions endpoint. Submit an invoice for delivery.","operationId":"create_invoice_submission","tags":["InvoiceSubmissions"],"consumes":["application/json"],"parameters":[{"name":"invoice_submission","in":"body","description":"Invoice to submit","required":true,"schema":{"$ref":"#/definitions/InvoiceSubmission"}}]}},"/document_submissions":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"}}},"200":{"description":"Success","schema":{"$ref":"#/definitions/DocumentSubmissionResult"}}},"summary":"Submit a new document.","description":"Submit a document for delivery.","operationId":"create_document_submission","tags":["DocumentSubmissions"],"consumes":["application/json"],"parameters":[{"name":"document_submission","in":"body","description":"Document to submit","required":true,"schema":{"$ref":"#/definitions/DocumentSubmission"}}]}},"/document_submissions/{guid}/evidence/{evidence_type}":{"get":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/DocumentSubmissionEvidence"}}},"summary":"Get DocumentSubmission Evidence","description":"Get evidence for a DocumentSubmission by GUID with corresponding status","operationId":"show_document_submission_evidence","tags":["DocumentSubmissions"],"consumes":["application/json"],"parameters":[{"name":"guid","in":"path","description":"DocumentSubmission GUID","required":true,"type":"string","format":"uuid"},{"name":"evidence_type","in":"path","description":"Type of evidence requested","required":false,"type":"string","enum":["sending","clearing"],"default":"sending"}]}},"/invoice_submissions/preflight":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"}}},"200":{"description":"Success","schema":{"$ref":"#/definitions/PreflightInvoiceRecipientResult"}}},"summary":"DEPRECATED. Preflight an invoice recipient","description":"Deprecated. Use the new /discovery endpoint. Check whether Storecove can deliver an invoice for a list of ids.","operationId":"preflight_invoice_recipient","tags":["InvoiceSubmissions"],"consumes":["application/json"],"parameters":[{"name":"invoice_recipient_preflight","in":"body","description":"The invoice recipient to preflight","required":true,"schema":{"$ref":"#/definitions/InvoiceRecipientPreflight"}}]}},"/legal_entities":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"}}},"200":{"description":"Success","schema":{"$ref":"#/definitions/LegalEntity"}}},"summary":"Create a new LegalEntity","description":"Create a new LegalEntity.","operationId":"create_legal_entity","tags":["LegalEntities"],"consumes":["application/json"],"parameters":[{"name":"legal_entity","in":"body","description":"LegalEntity to create","required":true,"schema":{"$ref":"#/definitions/LegalEntityCreate"}}]}},"/legal_entities/{id}":{"get":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/LegalEntity"}}},"summary":"Get LegalEntity","description":"Get a specific LegalEntity.","operationId":"get_legal_entity","tags":["LegalEntities"],"parameters":[{"name":"id","in":"path","description":"legal_entity id","required":true,"type":"integer","format":"int64"}]},"delete":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"204":{"description":"Success"}},"summary":"Delete LegalEntity","description":"Delete a specific LegalEntity.","operationId":"delete_legal_entity","tags":["LegalEntities"],"parameters":[{"name":"id","in":"path","description":"legal_entity id","required":true,"type":"integer","format":"int64"}]},"patch":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"}}},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/LegalEntity"}}},"summary":"Update LegalEntity","description":"Update a specific LegalEntity.","operationId":"update_legal_entity","tags":["LegalEntities"],"parameters":[{"name":"id","in":"path","description":"legal_entity id","required":true,"type":"integer","format":"int64"},{"name":"legal_entity","in":"body","description":"LegalEntity updates","required":true,"schema":{"$ref":"#/definitions/LegalEntityUpdate"}}]}},"/legal_entities/{legal_entity_id}/peppol_identifiers":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"}}},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/PeppolIdentifier"}}},"summary":"Create a new PeppolIdentifier","description":"Create a brand new new PeppolIdentifier. For <<_singapore_corppass_description>>, special rules apply.","operationId":"create_peppol_identifier","tags":["PeppolIdentifiers"],"consumes":["application/json"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity for which to create the PeppolIdentifier","required":true,"type":"integer","format":"int64"},{"name":"peppol_identifier","in":"body","description":"PeppolIdentifier to create","required":true,"schema":{"$ref":"#/definitions/PeppolIdentifierCreate"}}]}},"/legal_entities/{legal_entity_id}/peppol_identifiers/{superscheme}/{scheme}/{identifier}":{"delete":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"204":{"description":"Success"}},"summary":"Delete PeppolIdentifier","description":"Delete a PeppolIdentifier.","operationId":"delete_peppol_identifier","tags":["PeppolIdentifiers"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity this PeppolIdentifier belongs to","required":true,"type":"integer","format":"int64"},{"name":"superscheme","in":"path","description":"The superscheme of the identifier. Should always be \"iso6523-actorid-upis\".","required":true,"type":"string"},{"name":"scheme","in":"path","description":"PEPPOL identifier scheme id, e.g. \"DE:VAT\". For a full list see <<_receiver_identifiers_list>>.","required":true,"type":"string"},{"name":"identifier","in":"path","description":"PEPPOL identifier","required":true,"type":"string"}]}},"/legal_entities/{legal_entity_id}/administrations":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"}}},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/Administration"}}},"summary":"DEPRECATED. Create a new Administration","description":"DEPRECATED. Create a new Administration. An Administration is an email destination for purchase invoices.","operationId":"create_administration","tags":["Administrations"],"consumes":["application/json"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity for which to create the Administration","required":true,"type":"integer","format":"int64"},{"name":"administration","in":"body","description":"Administration to create","required":true,"schema":{"$ref":"#/definitions/AdministrationCreate"}}]}},"/legal_entities/{legal_entity_id}/administrations/{id}":{"get":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/Administration"}}},"summary":"DEPRECATED. Get Administration","description":"DEPRECATED. Get an Administration","operationId":"get_administration","tags":["Administrations"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity the Administration belongs to","required":true,"type":"integer","format":"int64"},{"name":"id","in":"path","description":"The id of the Administration","required":true,"type":"integer","format":"int64"}]},"delete":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"204":{"description":"Success"}},"summary":"DEPRECATED. Delete Administration","description":"DEPRECATED. Delete an Administration","operationId":"delete_administration","tags":["Administrations"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity the Administration belongs to","required":true,"type":"integer","format":"int64"},{"name":"id","in":"path","description":"The id of the Administration","required":true,"type":"integer","format":"int64"}]},"patch":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/Administration"}}},"summary":"DEPRECATED. Update Administration","description":"DEPRECATED. Update an Administration","operationId":"update_administration","tags":["Administrations"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity the Administration belongs to","required":true,"type":"integer","format":"int64"},{"name":"id","in":"path","description":"The id of the Administration to be updated","required":true,"type":"integer","format":"int64"},{"name":"administration","in":"body","description":"Administration to update","required":true,"schema":{"$ref":"#/definitions/AdministrationUpdate"}}]}},"/legal_entities/{legal_entity_id}/additional_tax_identifiers":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"}}},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/AdditionalTaxIdentifier"}}},"summary":"Create a new AdditionalTaxIdentifier","description":"Create a new AdditionalTaxIdentifier. An AdditionalTaxIdentifier is a seconday tax identifier that is used inside the EU when sending invoices to consumers. In that case, the VAT of the receiving country is used and if the sender has a local VAT identifier, that is used to identifiy the sender, instead of the sender's origin country VAT number. To use these identifiers, use the invoice.consumerTaxMode = true property.","operationId":"create_additional_tax_identifier","tags":["AdditionalTaxIdentifiers"],"consumes":["application/json"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity for which to create the AdditionalTaxIdentifier","required":true,"type":"integer","format":"int64"},{"name":"additional_tax_identifier","in":"body","description":"AdditionalTaxIdentifier to create","required":true,"schema":{"$ref":"#/definitions/AdditionalTaxIdentifierCreate"}}]}},"/legal_entities/{legal_entity_id}/additional_tax_identifiers/{id}":{"get":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/AdditionalTaxIdentifier"}}},"summary":"Get AdditionalTaxIdentifier","description":"Get an AdditionalTaxIdentifier","operationId":"get_additional_tax_identifier","tags":["AdditionalTaxIdentifiers"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity the AdditionalTaxIdentifier belongs to","required":true,"type":"integer","format":"int64"},{"name":"id","in":"path","description":"The id of the AdditionalTaxIdentifier","required":true,"type":"integer","format":"int64"}]},"delete":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"204":{"description":"Success"}},"summary":"Delete AdditionalTaxIdentifier","description":"Delete an AdditionalTaxIdentifier","operationId":"delete_additional_tax_identifier","tags":["AdditionalTaxIdentifiers"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity the AdditionalTaxIdentifier belongs to","required":true,"type":"integer","format":"int64"},{"name":"id","in":"path","description":"The id of the AdditionalTaxIdentifier","required":true,"type":"integer","format":"int64"}]},"patch":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/AdditionalTaxIdentifier"}}},"summary":"Update AdditionalTaxIdentifier","description":"Update an AdditionalTaxIdentifier","operationId":"update_additional_tax_identifier","tags":["AdditionalTaxIdentifiers"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity the AdditionalTaxIdentifier belongs to","required":true,"type":"integer","format":"int64"},{"name":"id","in":"path","description":"The id of the AdditionalTaxIdentifier to be updated","required":true,"type":"integer","format":"int64"},{"name":"additional_tax_identifier","in":"body","description":"AdditionalTaxIdentifier to update","required":true,"schema":{"$ref":"#/definitions/AdditionalTaxIdentifierUpdate"}}]}},"/purchase_invoices/{guid}":{"get":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/PurchaseInvoice"}}},"summary":"DEPRECATED. Get Purchase invoice data as JSON","description":"DEPRECATED. Use the /api/v2/received_documents endpoint. Get a specific PurchaseInvoice, in JSON format.","operationId":"get_invoice_json","tags":["PurchaseInvoices"],"parameters":[{"name":"guid","in":"path","description":"The guid of the purchase invoice, from the webhook.","required":true,"type":"string","format":"uuid"},{"name":"pmv","in":"query","description":"DEPRECATED. The PaymentMeans version. The default (and deprecated) version 1.0 will give BankPaymentMean, DirectDebitPaymentMean, CardPaymentMean, NppPaymentMean, SeBankGiroPaymentMean, SePlusGiroPaymentMean, SgCardPaymentMean, SgGiroPaymentMean, SgPaynowPaymentMean.\n\nVersion 2.0 deprecates BankPaymentMean (now CreditTransferPaymentMean), CardPaymentMean (now CreditCardPaymentMean), NppPaymentMean (now AunzNppPayidPaymentMean), SeBankGiroPaymentMean (now SeBankgiroPaymentMean  -- note the lower 'g' in 'bankgiro'). It also adds OnlinePaymentServicePaymentMean, StandingAgreementPaymentMean, AunzNppPaytoPaymentMean, AunzBpayPaymentMean, AunzPostbillpayPaymentMean, AunzUriPaymentMean.","required":false,"type":"string","default":"1.0"},{"name":"version","in":"query","description":"The JSON content version date. The default is '1970-01-01' meaning you get all deprecated elements since nothing was deprecated before that ;). If you do not want deprecated elements, use a later date. Do not use a dynamic date, because that means when we deprecate elements they will disappear from our responses.","required":false,"type":"string","pattern":"^d{4}-d{2}-d{2}$","default":"1970-01-01"}]}},"/purchase_invoices/{guid}/{packaging}":{"get":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/PurchaseInvoiceUbl"}}},"summary":"DEPRECATED. Get Purchase invoice data in a selectable format","description":"DEPRECATED. Use the /api/v2/received_documents endpoint. Get a specific PurchaseInvoice.","operationId":"get_invoice_ubl","tags":["PurchaseInvoices"],"parameters":[{"name":"guid","in":"path","description":"purchase invoice guid","required":true,"type":"string","format":"uuid"},{"name":"packaging","in":"path","description":"How to package the purchase invoice. Note that \"ubl\" is deprecated.","required":true,"type":"string","enum":["json","ubl","original"],"default":"json"},{"name":"pmv","in":"query","description":"DEPRECATED. The PaymentMeans version. The default (and deprecated) version 1.0 will give BankPaymentMean, DirectDebitPaymentMean, CardPaymentMean, NppPaymentMean, SeBankGiroPaymentMean, SePlusGiroPaymentMean, SgCardPaymentMean, SgGiroPaymentMean, SgPaynowPaymentMean.\n\nVersion 2.0 deprecates BankPaymentMean (now CreditTransferPaymentMean), CardPaymentMean (now CreditCardPaymentMean), NppPaymentMean (now AunzNppPayidPaymentMean), SeBankGiroPaymentMean (now SeBankgiroPaymentMean  -- note the lower 'g' in 'bankgiro'). It also adds OnlinePaymentServicePaymentMean, StandingAgreementPaymentMean, AunzNppPaytoPaymentMean, AunzBpayPaymentMean, AunzPostbillpayPaymentMean, AunzUriPaymentMean.","required":false,"type":"string","default":"1.0"},{"name":"version","in":"query","description":"The JSON content version date. The default is '1970-01-01' meaning you get all deprecated elements since nothing was deprecated before that ;). If you do not want deprecated elements, use a later date. Do not use a dynamic date, because that means when we deprecate elements they will disappear from our responses. Only used for 'json' packaging, not for 'original'.","required":false,"type":"string","pattern":"^d{4}-d{2}-d{2}$","default":"1970-01-01"}]}},"/purchase_invoices/{guid}/{packaging}/{package_version}":{"get":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/PurchaseInvoiceUbl"}}},"summary":"DEPRECATED. Get Purchase invoice data as JSON with a Base64-encoded UBL string in the specified version","description":"DEPRECATED. Get a specific PurchaseInvoice in UBL format","operationId":"get_invoice_ubl_versioned","tags":["PurchaseInvoices"],"parameters":[{"name":"guid","in":"path","description":"purchase invoice guid","required":true,"type":"string","format":"uuid"},{"name":"packaging","in":"path","description":"How to package the purchase invoice.","required":true,"type":"string","enum":["ubl"],"default":"ubl"},{"name":"package_version","in":"path","description":"The version of the package.","required":true,"type":"string","enum":["si11","si12","si20","aunz","sg","jp","en16931","original"],"default":"si11"}]}},"/webhook_instances/":{"get":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/WebhookInstance"}},"204":{"description":"Success"}},"summary":"GET a WebhookInstance","description":"GET a WebhookInstance from the queue. After processing it successfully, DELETE it and GET the next one. When a 204 is received, the queue is empty and the polling process can sleep for a while.","operationId":"get_webhook_instances","tags":["WebhookInstances"]}},"/webhook_instances/{guid}":{"delete":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"204":{"description":"Success"}},"summary":"DELETE a WebhookInstance","description":"DELETE a specific WebhookInstance","operationId":"delete_webhook_instance","tags":["WebhookInstances"],"parameters":[{"name":"guid","in":"path","description":"WebhookInstance guid","required":true,"type":"string","format":"uuid"}]}},"/discovery/receives":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"}}},"200":{"description":"Success","schema":{"$ref":"#/definitions/DiscoveredParticipant"}}},"summary":"Discover Network Participant Capabilites","description":"Discover a network participant and their capabilities.","operationId":"discovery_receives","tags":["Discovery"],"consumes":["application/json"],"parameters":[{"name":"discoverable_participant","in":"body","description":"The participant to check","required":true,"schema":{"$ref":"#/definitions/DiscoverableParticipant"}}]}},"/discovery/exists":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"}}},"200":{"description":"Success","schema":{"$ref":"#/definitions/DiscoveredParticipant"}}},"summary":"Discover Network Participant Existence","description":"Discover if a network participant exists.","operationId":"discovery_exists","tags":["Discovery"],"consumes":["application/json"],"parameters":[{"name":"discoverable_participant","in":"body","description":"The participant to check","required":true,"schema":{"$ref":"#/definitions/DiscoverableParticipant"}}]}},"/discovery/identifiers":{"get":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"200":{"description":"Success","schema":{"$ref":"#/definitions/CountrySpecifications"}}},"summary":"Discover Country Identifiers ** EXPERIMENTAL","description":"Discover the identifiers used in each country, for routing, for legal identification as well as for tax identification purposes. We are currently testing this endpoint with selected Customers. If you would like to participate, please contact us.","operationId":"discovery_identifiers","tags":["Discovery"]}},"/legal_entities/{legal_entity_id}/received_documents":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"}}},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/ReceivedDocument"}}},"summary":"Receive a new Document","description":"Let us know about a new Document you have received. It will be parsed and then you will receive the \"received_document\" webhook. You can use the information in the webhook to retrieve the parsed JSON or the original through a GET request.","operationId":"receive_document","tags":["ReceivedDocuments"],"consumes":["application/json"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity for which the document was received.","required":true,"type":"integer","format":"int64"},{"name":"received_document","in":"body","description":"Received document to process.","required":true,"schema":{"$ref":"#/definitions/ReceivedDocumentCreate"}}]}},"/received_documents/{guid}/{format}":{"get":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"400":{"description":"Bad Request"},"200":{"description":"Success","schema":{"$ref":"#/definitions/Transportable"}}},"summary":"Get a new ReceivedDocument","description":"Get a new ReceivedDocument that you have been notified for via received_document webhook.","operationId":"get_received_document","tags":["ReceivedDocuments"],"consumes":["application/json"],"parameters":[{"name":"guid","in":"path","description":"The guid of the document that was received. This is the \"document_guid\" property of the \"received_document\" webhook.","required":true,"type":"string","format":"uuid"},{"name":"format","in":"path","description":"The format in which to receive the received document.","required":false,"type":"string","enum":["json","original"],"default":"json"},{"name":"version","in":"query","description":"The JSON content version date. The default is '1970-01-01' meaning you get all deprecated elements since nothing was deprecated before that ;). If you do not want deprecated elements, use a later date. Do not use a dynamic date, because that means when we deprecate elements they will disappear from our responses. Only used for 'json' packaging, not for 'original'. Not currently used for invoices, only for orders.","required":false,"type":"string","pattern":"^d{4}-d{2}-d{2}$","default":"1970-01-01"}]}},"/api/v2/legal_entities/{legal_entity_id}/c5/iras/email/activate":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"$ref":"#/definitions/C5EmailResponse"}},"404":{"description":"Not Found"},"204":{"description":"Empty success response"}},"summary":"Request a new C5 Email Activation","description":"Request a new C5 Email Activation. Currently only used for SG:UEN identifiers towards SG IRAS.","operationId":"create_c5_email","tags":["C5Activation"],"consumes":["application/json"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity for which to create the C5EmailRequest","required":true,"type":"integer","format":"int64"},{"name":"c5_email_request","in":"body","description":"The C5EmailRequest to initiate","required":true,"schema":{"$ref":"#/definitions/C5EmailRequest"}}]}},"/api/v2/legal_entities/{legal_entity_id}/c5/iras/email/deactivate":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"$ref":"#/definitions/C5ErrorResponse"}},"404":{"description":"Not Found"},"204":{"description":"Empty success response"}},"summary":"Request a new C5 Email Deactivation","description":"Request a new C5 Email Deactivation. Currently only used for SG:UEN identifiers towards SG IRAS.","operationId":"deactivate_c5_email","tags":["C5Activation"],"consumes":["application/json"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity for which to create the C5EmailRequest","required":true,"type":"integer","format":"int64"},{"name":"c5_email_request","in":"body","description":"The C5EmailRequest to initiate","required":true,"schema":{"$ref":"#/definitions/C5EmailRequest"}}]}},"/api/v2/legal_entities/{legal_entity_id}/c5/iras/email/cancel":{"put":{"summary":"Cancel a C5 email activation or deactivation","description":"Cancel an initiated C5 email activation or deactivation","tags":["C5Activation"],"parameters":[{"name":"legal_entity_id","in":"path","description":"Legal entity ID","required":true,"type":"string"},{"name":"c5_email_cancellation_request","in":"body","description":"The C5EmailCancellationRequest to cancel","required":true,"schema":{"$ref":"#/definitions/C5EmailCancellationRequest"}}],"responses":{"204":{"description":"If cancellation of a initiated C5 activation / C5 deactivation is successful."},"422":{"description":"The C5 activation/deactivation is in an incorrect state and can not be cancelled."}}}},"/api/v2/legal_entities/{legal_entity_id}/c5/iras/redirect/activate":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"$ref":"#/definitions/C5RedirectResponse"}},"404":{"description":"Not Found"},"200":{"description":"Success response","schema":{"$ref":"#/definitions/C5RedirectResponse"}}},"summary":"Request a new C5 Redirect Activation","description":"Request a new C5 Redirect Activation. Currently only used for SG:UEN identifiers towards SG IRAS.","operationId":"activate_c5_redirect","tags":["C5Activation"],"consumes":["application/json"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity for which to create the C5RedirectRequest","required":true,"type":"integer","format":"int64"},{"name":"c5_redirect_request","in":"body","description":"The C5RedirectRequest to initiate","required":true,"schema":{"$ref":"#/definitions/C5RedirectRequest"}}]}},"/api/v2/legal_entities/{legal_entity_id}/c5/iras/redirect/deactivate":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"$ref":"#/definitions/C5ErrorResponse"}},"404":{"description":"Not Found"},"200":{"description":"Success response","schema":{"$ref":"#/definitions/C5RedirectResponse"}}},"summary":"Request a new C5 Redirect Deactivation","description":"Request a new C5 Redirect Deactivation. Currently only used for SG:UEN identifiers towards SG IRAS.","operationId":"deactivate_c5_redirect","tags":["C5Activation"],"consumes":["application/json"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity for which to create the C5RedirectRequest","required":true,"type":"integer","format":"int64"},{"name":"c5_redirect_request","in":"body","description":"The C5RedirectRequest to initiate","required":true,"schema":{"$ref":"#/definitions/C5RedirectRequest"}}]}},"/api/v2/legal_entities/{legal_entity_id}/c5/iras/redirect/cancel":{"put":{"summary":"Cancel a C5 redirect activation or deactivation","description":"Cancel an initiated C5 redirect activation or deactivation","tags":["C5Activation"],"parameters":[{"name":"legal_entity_id","in":"path","description":"Legal entity ID","required":true,"type":"string"},{"name":"c5_redirect_cancellation_request","in":"body","description":"The C5RedirectCancellationRequest to cancel","required":true,"schema":{"$ref":"#/definitions/C5RedirectCancellationRequest"}}],"responses":{"204":{"description":"If cancellation of a initiated C5 activation / C5 deactivation is successful."},"422":{"description":"The C5 activation/deactivation is in an incorrect state and can not be cancelled."}}}},"/api/v2/legal_entities/{legal_entity_id}/c5_activation/activate":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"}}},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/C5ActivationResponse"}}},"summary":"DEPRECATED. Request a new C5 Activation","description":"DEPRECATED. Request a new C5 Activation. Currently only used for SG:UEN identifiers towards SG IRAS.","operationId":"create_c5_activation","tags":["C5Activation"],"consumes":["application/json"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity for which to create the C5ActivationRequest","required":true,"type":"integer","format":"int64"},{"name":"c5_activation_request","in":"body","description":"The C5ActivationRequest to initiate","required":true,"schema":{"$ref":"#/definitions/C5ActivationRequest"}}]}},"/api/v2/legal_entities/{legal_entity_id}/c5_deactivation/deactivate":{"post":{"responses":{"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable Entity","schema":{"type":"array","items":{"$ref":"#/definitions/ErrorModel"}}},"404":{"description":"Not Found"},"200":{"description":"Success","schema":{"$ref":"#/definitions/C5DeactivationResponse"}}},"summary":"DEPRECATED. Request a new C5 Deactivation","description":"DEPRECATED. Request a new C5 Deactivation. Currently only used for SG:UEN identifiers towards SG IRAS.","operationId":"create_c5_deactivation","tags":["C5Activation"],"consumes":["application/json"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The id of the LegalEntity for which to create the C5DeactivationRequest","required":true,"type":"integer","format":"int64"},{"name":"c5_deactivation_request","in":"body","description":"The C5DeactivationRequest to initiate","required":true,"schema":{"$ref":"#/definitions/C5DeactivationRequest"}}]}}},"definitions":{"LegalEntityUpdate":{"properties":{"id":{"title":"Id","description":"The Storecove assigned id for the LegalEntity.","type":"integer","format":"int64"},"party_name":{"type":"string","title":"Company name","description":"The name of the company.","minLength":2,"maxLength":64},"line1":{"type":"string","title":"Address line 1","description":"The first address line.","minLength":2,"maxLength":192},"line2":{"type":"string","title":"Address line 2","description":"The second address line, if applicable","maxLength":192},"city":{"type":"string","title":"City","description":"The city.","minLength":2,"maxLength":64},"zip":{"type":"string","title":"Zipcode","description":"The zipcode.","minLength":2,"maxLength":32},"county":{"type":"string","title":"County","description":"County, if applicable","maxLength":64},"country":{"$ref":"#/definitions/Country"},"tenant_id":{"type":"string","title":"Tenant Id","description":"The id of the tenant, to be used in case of multi-tenant solutions. This property will included in webhook events.","maxLength":64},"public":{"type":"boolean","title":"Public","description":"Whether or not this LegalEntity is public. Public means it will be listed in the PEPPOL directory at https://directory.peppol.eu/ which is normally what you want. If you have a good reason to not want the LegalEntity listed, provide false. This property is ignored when for country SG, where it is always true.","default":true},"advertisements":{"title":"Advertisements","description":"A list of document groups to advertise.\n++++\n<ul>    <li>        <strong>invoice</strong><br/>        Gives Invoice and where applicable CreditNote under the Billing process.<br/>    </li>    <li>        <strong>invoice_response</strong><br/>        Gives InvoiceResponse under the Invoice Response process.<br/>    </li>    <li>        <strong>selfbilling</strong><br/>        Gives Invoice and where applicable CreditNote under the Selfbilling process.<br/>    </li>    <li>        <strong>order</strong><br/>        Gives Order under the Order Only process.<br/>    </li>    <li>        <strong>ordering</strong><br/>        Gives Order and OrderResponse under the Ordering process.<br/>    </li>    <li>        <strong>advanced_ordering</strong><br/>        Gives Order, AdvancedOrderResponse, OrderChange and OrderCancellation under the Advanced Ordering process.<br/>    </li>    <li>        <strong>despatch_advice</strong><br/>        Gives DespatchAdvice under the Despatch Advice process.<br/>    </li>    <li>        <strong>advanced_ordering_sg_order_balance</strong><br/>        Gives OrderBalance under the Advanced Ordering SG Order Balance process.<br/>    </li>    <li>        <strong>remittance_advice</strong><br/>        Gives RemittanceAdvice (DBNAlliance only).<br/>    </li>    <li>        <strong>pidx_invoicing_ordering</strong><br/>        Gives PIDX Invoice, InvoiceResponse, OrderChange, OrderCreate and OrderResponse (DBNAlliance only).<br/>    </li></ul>\n++++\n","type":"array","items":{"type":"string","enum":["invoice","invoice_response","selfbilling","order","ordering","advanced_ordering","advanced_ordering_sg_order_balance","remittance_advice","despatch_advice","pidx_invoicing_ordering"]},"default":["invoice"]},"third_party_username":{"type":"string","title":"Username","description":"The username to use to authenticate to a system through which to send the document, or to obtain tax authority approval to send it. This field is currently relevant only for India and mandatory when creating an IN LegalEntity.","minLength":2,"maxLength":64},"third_party_password":{"type":"string","title":"Password","description":"The password to use to authenticate to a system through which to send the document, or to obtain tax authority approval to send it. This field is currently relevant only for India and mandatory when creating an IN LegalEntity.","minLength":2,"maxLength":64},"rea":{"title":"REA Details","description":"The REA details for the LegalEntity. Only applies to IT LegalEntities.","type":"object","$ref":"#/definitions/Rea"},"smart_inbox":{"title":"Smart Inbox Email Address","description":"DEPRECATED. Use the <<_openapi_receiveddocuments_resource>> endpoint. The email address of the Smart Inbox for this LegalEntity.","type":"string"},"acts_as_sender":{"type":"boolean","title":"Acts As Sender","description":"Whether or not this LegalEntity can act as a sender of documents.","default":true},"acts_as_receiver":{"type":"boolean","title":"Acts As Receiver","description":"Whether or not this LegalEntity can act as a receiver of documents. If not, no identifiers will be provioned on any exchange network.","default":true},"tax_registered":{"type":"boolean","title":"Tax Registered","description":"Whether or not this LegalEntity is tax registered. This influences the validation of the data presented when sending documents.","default":true},"override_own_credentials":{"type":"boolean","title":"Override Own Credentials","description":"If true, Storecove will use default credentials/signing artifacts even if specific ones are configured for this LegalEntity. Defaults to false.","default":false},"classification_code":{"type":"string","title":"Classification Code","description":"The classification code for this LegalEntity. For Malaysia, this is the MSIC code. It is mandatory for MY legal entities."}}},"LegalEntityCreate":{"properties":{"party_name":{"type":"string","title":"Company name","description":"The name of the company.","minLength":2,"maxLength":64},"line1":{"type":"string","title":"Address line 1","description":"The first address line.","minLength":2,"maxLength":192},"line2":{"type":"string","title":"Address line 2","description":"The second address line, if applicable","maxLength":192},"city":{"type":"string","title":"City","description":"The city.","minLength":2,"maxLength":64},"zip":{"type":"string","title":"Zipcode","description":"The zipcode.","minLength":2,"maxLength":32},"county":{"type":"string","title":"County","description":"County, if applicable","maxLength":64},"country":{"$ref":"#/definitions/Country"},"tenant_id":{"type":"string","title":"Tenant Id","description":"The id of the tenant, to be used in case of single-tenant solutions that share webhook URLs. This property will included in webhook events.","maxLength":64},"public":{"type":"boolean","title":"Public","description":"Whether or not this LegalEntity is public. Public means it will be entered into the PEPPOL directory at https://directory.peppol.eu/","default":true},"advertisements":{"title":"Advertisements","description":"A list of document groups to advertise.\n++++\n<ul>    <li>        <strong>invoice</strong><br/>        Gives Invoice and where applicable CreditNote under the Billing process.<br/>    </li>    <li>        <strong>invoice_response</strong><br/>        Gives InvoiceResponse under the Invoice Response process.<br/>    </li>    <li>        <strong>selfbilling</strong><br/>        Gives Invoice and where applicable CreditNote under the Selfbilling process.<br/>    </li>    <li>        <strong>order</strong><br/>        Gives Order under the Order Only process.<br/>    </li>    <li>        <strong>ordering</strong><br/>        Gives Order and OrderResponse under the Ordering process.<br/>    </li>    <li>        <strong>advanced_ordering</strong><br/>        Gives Order, AdvancedOrderResponse, OrderChange and OrderCancellation under the Advanced Ordering process.<br/>    </li>    <li>        <strong>advanced_ordering_sg_order_balance</strong><br/>        Gives OrderBalance under the Advanced Ordering SG Order Balance process.<br/>    </li>    <li>        <strong>remittance_advice</strong><br/>        Gives RemittanceAdvice (DBNAlliance only).<br/>    </li>    <li>        <strong>pidx_invoicing_ordering</strong><br/>        Gives PIDX Invoice, InvoiceResponse, OrderChange, OrderCreate and OrderResponse (DBNAlliance only).<br/>    </li></ul>\n++++\n","type":"array","items":{"type":"string","enum":["invoice","invoice_response","selfbilling","order","ordering","advanced_ordering","advanced_ordering_sg_order_balance","remittance_advice","pidx_invoicing_ordering"]},"default":["invoice"]},"third_party_username":{"type":"string","title":"Username","description":"The username to use to authenticate to a system through which to send the document, or to obtain tax authority approval to send it. This field is currently relevant only for India and mandatory when creating an IN LegalEntity.","minLength":2,"maxLength":64},"third_party_password":{"type":"string","title":"Password","description":"The password to use to authenticate to a system through which to send the document, or to obtain tax authority approval to send it. This field is currently relevant only for India and mandatory when creating an IN LegalEntity.","minLength":2,"maxLength":64},"rea":{"title":"REA Details","description":"The REA details for the LegalEntity. Only applies to IT LegalEntities.","type":"object","$ref":"#/definitions/Rea"},"acts_as_sender":{"type":"boolean","title":"Acts As Sender","description":"Whether or not this LegalEntity can act as a sender of documents.","default":true},"acts_as_receiver":{"type":"boolean","title":"Acts As Receiver","description":"Whether or not this LegalEntity can act as a receiver of documents. If not, no identifiers will be provioned on any exchange network.","default":true},"tax_registered":{"type":"boolean","title":"Tax Registered","description":"Whether or not this LegalEntity is tax registered. This influences the validation of the data presented when sending documents.","default":true},"override_own_credentials":{"type":"boolean","title":"Override Own Credentials","description":"If true, Storecove will use default credentials/signing artifacts even if specific ones are configured for this LegalEntity. Defaults to false.","default":false}},"required":["party_name","line1","city","zip","country"]},"LegalEntity":{"allOf":[{"$ref":"#/definitions/LegalEntityUpdate"},{"properties":{"peppol_identifiers":{"type":"array","items":{"$ref":"#/definitions/PeppolIdentifier"}}}},{"properties":{"additional_tax_identifiers":{"type":"array","items":{"$ref":"#/definitions/AdditionalTaxIdentifier"}}}},{"properties":{"api_keys":{"type":"array","items":{"type":"string"}}}}]},"Rea":{"properties":{"province":{"title":"Province","description":"The provincia of the ufficio that issued the identifier.","type":"string","enum":["AG","AL","AN","AO","AQ","AR","AP","AT","AV","BA","BT","BL","BN","BG","BI","BO","BZ","BS","BR","CA","CL","CB","CI","CE","CT","CZ","CH","CO","CS","CR","KR","CN","EN","FM","FE","FI","FG","FC","FR","GE","GO","GR","IM","IS","SP","LT","LE","LC","LI","LO","LU","MC","MN","MS","MT","VS","ME","MI","MO","MB","NA","NO","NU","OG","OT","OR","PD","PA","PR","PV","PG","PU","PE","PC","PI","PT","PN","PZ","PO","RG","RA","RC","RE","RI","RN","RO","SA","SS","SV","SI","SR","SO","TA","TE","TR","TO","TP","TN","TV","TS","UD","VA","VE","VB","VC","VR","VV","VI","VT"]},"identifier":{"title":"Identifier","description":"The identifier.","type":"string","minLength":2,"maxLength":20},"capital":{"title":"Capital","description":"The captial for the company.","type":"number","min":1,"max":999999999999.99},"partners":{"title":"Partners","description":"The number of partners.","type":"string","enum":["SU","SM"]},"liquidation_status":{"title":"Liquidation Status","description":"The liquidation status of the company.","type":"string","enum":["LN","LS"]}}},"PeppolIdentifier":{"properties":{"identifier":{"type":"string","title":"Identifier","description":"The identifier.","minLength":2,"maxLength":64},"scheme":{"type":"string","title":"Type","description":"The scheme of the identifier. See <<_receiver_identifiers_list>> for a list.","minLength":2,"maxLength":64},"superscheme":{"type":"string","title":"Type","description":"The superscheme of the identifier. Should always be \"iso6523-actorid-upis\".","minLength":2,"maxLength":64},"corppass":{"title":"CorpPass Details","description":"CorpPass details, if applicable.","type":"object","$ref":"#/definitions/CorpPass"}}},"PeppolIdentifierCreate":{"properties":{"identifier":{"type":"string","title":"Identifier","description":"The identifier.","minLength":2,"maxLength":64},"scheme":{"type":"string","title":"Type","description":"The scheme of the identifier. See <<_receiver_identifiers_list>> for a list.","minLength":2,"maxLength":64},"superscheme":{"type":"string","title":"Type","description":"The superscheme of the identifier. Should always be \"iso6523-actorid-upis\".","minLength":2,"maxLength":64},"networks":{"title":"Networks","description":"DEPRECATED. Use the new \"networks_specification\" property. The networks to advertise the identifier on. Note that \"dbnalliance\" currently requires manual provisioning in the DBNAlliance SML, so you need to contact us before using this.","type":"array","items":{"title":"Network","description":"A network to advertise the identifier on.","type":"string","enum":["peppol","dbnalliance","dgfip"]},"default":["peppol"]},"networks_specification":{"title":"Networks Specification","description":"A specification of the networks to advertise the identifier on.","type":"array","items":{"$ref":"#/definitions/NetworkSpecification"}},"corppass":{"title":"CorpPass Details","description":"CorpPass details, used to create SG:UEN (numerical code: 0195) identifiers. For details, see <<_singapore_corppass_description>>.","type":"object","$ref":"#/definitions/CorpPassCreate"}},"required":["identifier","scheme","superscheme"]},"NetworkSpecification":{"properties":{"name":{"title":"Network","description":"A network to advertise the identifier on.","type":"string","enum":["peppol","dbnalliance","dgfip"]},"sub_networks":{"title":"Sub Networks","description":"A list of sub_networks to advertise documents for. The Peppol network has two sub_networks: \"france\" (for the upcoming French reform) and \"eb2b\" (enhanced B2B). Use \"main\" to advertise on the main Peppol network.","type":"array","items":{"title":"Sub Network","description":"A sub_network to advertise documents for.","type":"string","enum":["main","france","eb2b"]}}}},"CorpPassCreate":{"properties":{"enabled":{"type":"boolean","title":"CorpPass","description":"DEPRECATED. Whether or not to enable the CorpPass flow. Must be true if provided.","default":true},"flow_type":{"title":"Flow Type","description":"The CorpPass flow type. Note that using corppass_flow_pdf requires special setup of your account by Storecove.","type":"string","enum":["corppass_flow_redirect","corppass_flow_email","corppass_flow_pdf"]},"signer_name":{"title":"Signer Name","description":"The name of the person who is going to perform the CorpPass process. Mandatory for flow_type=\"corppass_flow_email\"","type":"string","minLength":2,"maxLength":64},"signer_email":{"title":"Signer Email","description":"The email of the person who is going to perform the CorpPass process. Mandatory for flow_type=\"corppass_flow_email\"","type":"string","minLength":2,"maxLength":128},"client_redirect_success_url":{"title":"Client Redirect Success URL","description":"The URL the CorpPass system will redirect to in case of successful identity verfication. Mandatory for flow_type=\"corppass_flow_redirect\"","type":"string","minLength":11,"maxLength":255},"client_redirect_fail_url":{"title":"Client Redirect Success URL","description":"The URL the CorpPass system will redirect to in case of a failure to perform identity verfication. Mandatory for flow_type=\"corppass_flow_redirect\"","type":"string","minLength":11,"maxLength":255},"simulate_corppass":{"type":"boolean","title":"Simulate CorpPass","description":"Whether or not to simulate CorpPass. Instead of redirecting to a CorpPass URL, you will receive a redirect to a Storecove URL which will show a page with two buttons: success and fail. This makes development without having test CorpPass credentials possible. Note this only works in sandbox, not in the production environment.","default":false},"kyc_document":{"title":"KYC PDF document","description":"The Base64-encoded PDF document used for KYC. Mandatory for flow_type=\"corppass_flow_pdf\"","type":"string"}},"required":["flow_type"]},"CorpPass":{"properties":{"enabled":{"type":"boolean","title":"CorpPass","description":"Whether or not the CorpPass flow is enabled.","default":false},"flow_type":{"title":"Flow Type","description":"The CorpPass flow type.","type":"string","enum":["corppass_flow_redirect","corppass_flow_email","corppass_flow_pdf"]},"signer_name":{"title":"Signer Name","description":"The name of the person who is going to perform the CorpPass process.","type":"string","minLength":2,"maxLength":64},"signer_email":{"title":"Signer Email","description":"The email of the person who is going to perform the CorpPass process.","type":"string","minLength":2,"maxLength":128},"client_redirect_success_url":{"title":"Client Redirect Success URL","description":"The URL the CorpPass system will redirect to in case of successful identity verfication.","type":"string","minLength":11,"maxLength":255},"client_redirect_fail_url":{"title":"Client Redirect Success URL","description":"The URL the CorpPass system will redirect to in case of a failure to perform identity verfication.","type":"string","minLength":11,"maxLength":255},"corppass_url":{"title":"CorpPass redirect URL","description":"The CorpPass redirect URL.","type":"string","minLength":11,"maxLength":255},"status":{"title":"CorpPass Status","description":"The status of the CorpPass process.","type":"string","enum":["corppass_no_status","corppass_initiated","corppass_cancelled","corppass_failed","corppass_succeeded"]},"simulate_corppass":{"type":"boolean","title":"Simulate CorpPass","description":"Whether or not CorpPass is being simulated.","default":false}}},"AdministrationCreate":{"properties":{"sender_email_identity_id":{"title":"Sender email identity","description":"The id of the SenderEmailIdentity. If not provided, the Storecove default sender will be used","type":"integer","format":"int64"},"legal_entity_id":{"type":"integer","title":"Legal etity","description":"The LegalEntity the Administration belongs to.","format":"int64"},"email":{"type":"string","title":"Email","description":"The email address to send the received document to","minLength":5,"maxLength":128},"packaging":{"title":"Packaging","description":"How to package the purchase invoice.","type":"string","enum":["ubl"],"default":"ubl"},"package_version":{"title":"Package version","description":"The version of the package.","type":"string","enum":["peppol_bis_v3","aunz","sg"],"default":"peppol_bis_v3"}}},"AdministrationUpdate":{"properties":{"sender_email_identity_id":{"title":"Sender email identity","description":"The id of the SenderEmailIdentity. If not provided, the Storecove default sender will be used","type":"integer","format":"int64"},"email":{"type":"string","title":"Email","description":"The email address to send the received document to","minLength":5,"maxLength":128},"packaging":{"title":"Packaging","description":"How to package the purchase invoice.","type":"string","enum":["ubl"]},"package_version":{"title":"Package version","description":"The version of the package.","type":"string","enum":["peppol_bis_v3","aunz","sg"]}}},"Administration":{"properties":{"id":{"type":"integer","title":"Id","description":"The Storecove assigned id for the Administration.","format":"int64"},"sender_email_identity_id":{"title":"Sender email identity","description":"The id of the SenderEmailIdentity. If not provided, the Storecove default sender will be used","type":"integer","format":"int64"},"legal_entity_id":{"type":"integer","title":"Legal etity","description":"The LegalEntity the Administration belongs to.","format":"int64"},"email":{"type":"string","title":"Email","description":"The email address to send the received document to","minLength":5,"maxLength":128},"packaging":{"title":"Packaging","description":"How to package the purchase invoice.","type":"string","enum":["ubl"]},"package_version":{"title":"Package version","description":"The version of the package.","type":"string","enum":["peppol_bis_v3","aunz","sg"]}}},"AdditionalTaxIdentifierCreate":{"properties":{"country":{"type":"string","title":"Country","description":"The ISO3166 country code to use this identifier for in case of consumerTaxMode.","minLength":2,"maxLength":2},"county":{"type":"string","title":"County","description":"The county/state inside the country code to use this identifier for in case of consumerTaxMode. Leave empty to create an additional tax identifier for the entire country. For India, use the two last characters of ISO 3166-2:IN (https://en.wikipedia.org/wiki/States_and_union_territories_of_India).","minLength":2,"maxLength":2},"superscheme":{"type":"string","title":"Type","description":"The superscheme of the identifier. Should always be \"iso6523-actorid-upis\".","minLength":2,"maxLength":64},"scheme":{"type":"string","title":"Type","description":"The scheme of the identifier.","minLength":2,"maxLength":64},"identifier":{"title":"Identifier","description":"The identifier.","type":"string"},"third_party_username":{"type":"string","title":"Username","description":"The username to use to authenticate to a system through which to send the document, or to obtain tax authority approval to send it. This field is currently relevant only for India and mandatory when creating an IN tax identifier.","minLength":2,"maxLength":64},"third_party_password":{"type":"string","title":"Password","description":"The password to use to authenticate to a system through which to send the document, or to obtain tax authority approval to send it. This field is currently relevant only for India and mandatory when creating an IN tax identifier.","minLength":2,"maxLength":64}},"required":["country","identifier","scheme","superscheme"]},"AdditionalTaxIdentifierUpdate":{"properties":{"identifier":{"title":"Identifier","description":"The identifier.","type":"string"},"third_party_username":{"type":"string","title":"Username","description":"The username to use to authenticate to a system through which to send the document, or to obtain tax authority approval to send it. This field is currently relevant only for India and mandatory when creating an IN tax identifier.","minLength":2,"maxLength":64},"third_party_password":{"type":"string","title":"Password","description":"The password to use to authenticate to a system through which to send the document, or to obtain tax authority approval to send it. This field is currently relevant only for India and mandatory when creating an IN tax identifier.","minLength":2,"maxLength":64}},"required":["identifier"]},"AdditionalTaxIdentifier":{"properties":{"id":{"type":"integer","title":"Id","description":"The Storecove assigned id for the AdditionalTaxIdentifier.","format":"int64"},"country":{"type":"string","title":"Country","description":"The ISO3166 country code to use this identifier for in case of consumerTaxMode.","minLength":2,"maxLength":2},"county":{"type":"string","title":"County","description":"The county/state inside the country code to use this identifier for in case of consumerTaxMode.","minLength":2,"maxLength":2},"superscheme":{"type":"string","title":"Type","description":"The superscheme of the identifier.","minLength":2,"maxLength":64},"scheme":{"type":"string","title":"Type","description":"The scheme of the identifier.","minLength":2,"maxLength":64},"identifier":{"title":"Identifier","description":"The identifier.","type":"string"}}},"InvoiceSubmissionEvidence":{"properties":{"guid":{"title":"GUID","description":"The guid for the InvoiceSubmission.","type":"string"},"status":{"title":"Status","description":"The overall status for this InvoiceSubmission.","type":"string"},"actions":{"title":"Actions","description":"An array of actions taken to deliver the document.","type":"array","items":{"$ref":"#/definitions/InvoiceSubmissionActionEvidence"}}}},"DocumentSubmissionEvidence":{"properties":{"guid":{"title":"GUID","description":"The guid for the InvoiceSubmission.","type":"string"},"sender":{"title":"Sender","description":"The legal identifier of the sender, or the tax identifier if there is no legal identifier.","type":"string"},"receiver":{"title":"Receiver","description":"The legal identifier of the receiver, or the tax identifier if there is no legal identifier.","type":"string"},"network":{"title":"Network","description":"The network that was used to clear or send the document","type":"string","enum":["storecove","as2","email","peppol","dbnalliance","sdi","in-irp","pt-b2b","ch-qrbill","finvoice","pl-ksef","spain-face","spain-faceb2b","my-lhdnm"]},"documents":{"title":"Documents","description":"An array of documents that were sent. For OpenPeppol, this is always a single document (it may contain a PDF inside). For Email, the number of documents depends on the number of attachments, which in turn depends on the country of the receiver. For email, the raw email in RFC822 format is also included.","type":"array","items":{"$ref":"#/definitions/DocumentSubmissionEvidenceDocument"}},"evidence":{"title":"Evidence","description":"The evidence for this transmission.","type":"object","$ref":"#/definitions/DocumentSubmissionEvidenceEvidence"}}},"DocumentSubmissionEvidenceDocument":{"properties":{"document":{"title":"Dcoument","description":"The URL where the document can be retrieved.","type":"string"},"expires_at":{"title":"Expires At","description":"The datetime the URL expires. Format: 'YYYY-MM-DD HH:mm:ss.'","type":"string"},"mime_type":{"title":"Mime type","description":"The mime type of the document.","type":"string","enum":["message/rfc822","application/xml","application/json","application/pdf","application/pkcs7-mime"]}}},"DocumentSubmissionEvidenceEvidence":{"properties":{"smtp_response":{"title":"SMTP Response","description":"The response of the receiving SMTP server. Only used for network \"email\".","type":"string"},"timestamp":{"title":"Timestamp","description":"The timestamp of the delivery to the receiving SMTP server. Only used for network \"email\".","type":"string"},"reporting_mta":{"title":"Reporting MTA","description":"An identification for the sending SMTP. Only used for network \"email\".","type":"string"},"remote_mta_ip":{"title":"Remote MTA IP","description":"The IP address of the sending SMTP server. Only used for network \"email\".","type":"string"},"transmission_id":{"title":"Transmission ID","description":"The unique id for this transmission. The meaning of this field varies, depending on the network.","type":"string"},"message_id":{"title":"Message ID","description":"The meaning of this field varies, depending on the network. For peppol and dbnaliance, this is the message id of the envelope. For sdi, this is the filename assigned to the document.","type":"string"},"partner_key":{"title":"Partner Key","description":"The meaning of this field varies, depending on the network. For my-lhdnm, it is the UUID.","type":"string"},"long_id":{"title":"Long Id","description":"Only used for application my-lhdnm.","type":"string"},"acknowledgement_id":{"title":"Acknowledgement Id","description":"Only used for application sg-iras.","type":"string"},"correlation_id":{"title":"Correlation Id","description":"Only used for application sg-iras.","type":"string"},"document_id":{"title":"Document Id","description":"The UUID in the generated XML document. Only used for application my-lhdnm and sg-iras.","type":"string"},"receiving_accesspoint":{"title":"Receiving Accesspoint","description":"An identification of the OpenPeppol accesspoint that the invoice was sent to. Only used for exchange networks like peppol and dbnalliance.","type":"string"},"xml":{"title":"XML","description":"The XML evidence for the transmission. This is the XML returned by the receiving accesspoint, either OpenPeppol or DBNAlliance.","type":"string"},"signature":{"title":"Signature","description":"The signature assiged by the tax authority or its authorized partner. Used for network india.","type":"string"},"signature_date_time":{"title":"Signature Date Time","description":"The datetime of the signature assiged by the tax authority or its authorized partner. Used for network india.","type":"string"},"signature_number":{"title":"Signature Number","description":"The sequence number of the signature assiged by the tax authority or its authorized partner. Used for network india.","type":"string"},"qr_code":{"title":"QR Code","description":"The QR Code assiged by the tax authority or its authorized partner. Used for networks india and pt-b2b.","type":"string"}}},"InvoiceSubmissionActionEvidence":{"properties":{"transmission_datetime":{"title":"Transmission DateTime","description":"The DateTime of the transmission, as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z.","type":"string"},"transmission_type":{"title":"Transmission Type","description":"How the document was transmitted.","type":"string","enum":["email","edi","as2","peppol","sandbox"]},"transmission_result":{"title":"Transmission Result","description":"The result of this transmission.","type":"string","enum":["unknown","accepted","rejected","send_error","internal_error"]},"transmitted_document":{"title":"Transmitted Document","description":"The document that was transmitted.","type":"string"},"receiver_response":{"title":"Receiver Response","description":"The response the receiver sent.","type":"string"}}},"PurchaseInvoice":{"properties":{"external_user_id":{"title":"External user id","description":"Deprecated. Used for the embedded portal retrieval service. The external_user_id you provided when the ShopAccount was created.","type":"string"},"external_key":{"title":"External key","description":"Deprecated. Used for accountants. The id you specified for the organization.","type":"string"},"document":{"title":"Document","description":"DEPRECATED. Use the new atatchments array.","type":"string"},"invoice_type":{"title":"Invoice Type","description":"The type of invoice.","type":"string","enum":["invoice","creditnote","correctioninvoice"]},"vat_reverse_charge":{"title":"VAT Reverse Charge - DEPRECATED","description":"DEPRECATED - This is now part of each invoice line.","type":"boolean"},"amount_including_vat":{"title":"Amount Including VAT - DEPRECATED","description":"DEPRECATED - Use amount_including_tax.","type":"number"},"allowance_charge":{"title":"Allowance Charge - DEPRECATED","description":"DEPRECATED - Use the allowance_charges array.","type":"number"},"payment_means":{"title":"Payment Means - DEPRECATED","description":"DEPRECATED - Use the new payment_means_array array.","type":"object","properties":{"iban":{"title":"IBAN","description":"The IBAN to which to transfer.","type":"string"},"id":{"title":"Id","description":"An id to mention in the transfer.","type":"string"}}},"accounting":{"title":"Accounting Details - DEPRECATED","description":"DEPRECATED - The accounting details for the invoice. Will only evern contain null properties.","type":"object","$ref":"#/definitions/PurchaseInvoiceAccountingDetails"},"payment_means_payment_id":{"title":"Payment Means Payment Id - DEPRECATED","description":"DEPRECATED - use the payment_id property in the payment_means_array","type":"string"},"guid":{"title":"GUID","description":"The GUID of the invoice","type":"string","format":"uuid"},"legal_entity_id":{"title":"LegalEntity id","description":"The id of the LegalEntity the invoice was received for.","type":"integer","format":"int64"},"system_generated_primary_image":{"title":"System Generated Primary Image","description":"Whether or not the document image (PDF) was generated by Storecove. If true, it means the invoice was received without any attachments and Storecove generated one for you. If false, the invoice will contain at least one attachment, which was received from the invoice sender.","type":"boolean"},"document_type":{"title":"Document Type","description":"The type of document. Only \"invoice\" for now.","type":"string","enum":["invoice"]},"sub_type":{"title":"Document Subtype","description":"The subtype of document.","type":"string","enum":["invoice","creditnote","correctioninvoice"]},"source":{"title":"Invoice Source","description":"The source the invoice was received from.","type":"string","enum":["peppol","script","supplier","email"]},"tax_system":{"title":"Tax System","description":"The tax system of the invoice. Either tax_line_percentages or tax_line_amounts. The first tax system means the invoice lines contain only the tax percentages and the tax amounts are included only in the tax subtotals at the invoice level and so are only calculated at the invoice level. The tax system tax_line_amounts means that in addition to the percentage, each invoice line also contains the tax amount. The tax subtotals at the invoice level are calculated as the sum of the tax of the invoice lines. The distinction between the two tax systems has has implications for rounding.","type":"string"},"invoice_number":{"title":"Invoicenumber","description":"The invoicenumber.","type":"string"},"issue_date":{"title":"Issue Date","description":"The date the invoice was issued. Format \"YYYY-MM-DD\".","type":"string"},"tax_point_date":{"title":"Tax Point Date","description":"The date the invoice was issued for tax purposes. In most countries MUST match the issue_date. Format \"YYYY-MM-DD\".","type":"string"},"due_date":{"title":"Due Date","description":"The date the invoice must be payed by. Format \"YYYY-MM-DD\".","type":"string"},"document_currency_code":{"title":"Currency","description":"The ISO 4217 currency for the invoice.","type":"string"},"period_start":{"title":"Start of Period","description":"The start date of the period this invoice relates to. Format \"YYYY-MM-DD\".","type":"string"},"period_end":{"title":"End of Period","description":"The end date of the period this invoice relates to. Format \"YYYY-MM-DD\".","type":"string"},"note":{"title":"Note","description":"The invoice level note.","type":"string"},"buyer_reference":{"title":"Buyer Reference","description":"Reference provided by the buyer. Used for routing.","type":"string"},"billing_reference":{"title":"Billing Reference","description":"Reference to the previous invoice this invoice relates to.","type":"string"},"contract_document_reference":{"title":"Contract Document Reference","description":"Reference to the contract.","type":"string"},"order_reference":{"title":"Order Reference","description":"Reference to the order. Used for matching the invoice to an order.","type":"string"},"project_reference":{"title":"Project Reference","description":"Reference to the project.","type":"string"},"accounting_cost":{"title":"Accounting Cost","description":"The accounting cost code.","type":"string"},"attachments":{"type":"array","items":{"$ref":"#/definitions/PurchaseInvoiceAttachment"}},"sender":{"title":"Invoice Sender","description":"The organzation that sent the invoice.","type":"object","$ref":"#/definitions/PurchaseInvoiceSender"},"payment_terms_note":{"title":"Payment Terms Note","description":"A textual description of the payment terms.","type":"string"},"payment_means_array":{"title":"Payment Means","description":"The different payment means that can be used to pay the invoice.","type":"array","items":{"$ref":"#/definitions/PurchaseInvoicePaymentMeans"}},"delivery":{"title":"PurchaseInvoice Delivery","description":"The details of the delivery associated with this invoice.","type":"object","properties":{"actual_date":{"title":"Actual Date","description":"The actual delivery date.","type":"string"},"party":{"title":"PurchaseInvoice Party","description":"The party the goods/services were delivered to.","type":"object","properties":{"name":{"title":"Name","description":"The name of the deliveyr party.","type":"string"}}},"location":{"title":"Location","description":"The location the goods/services were delivered to.","type":"object","properties":{"id":{"title":"Id","description":"The id of the location.","type":"string"},"scheme_id":{"title":"Scheme Id","description":"The scheme id for the id of the location.","type":"string"},"department":{"title":"Department","description":"Department name.","type":"string"},"line1":{"title":"Line 1","description":"Address line 1.","type":"string"},"line2":{"title":"Line 2","description":"Address line 2.","type":"string"},"zip":{"title":"Zip","description":"Address zip code","type":"string"},"city":{"title":"City","description":"Address city.","type":"string"},"building_number":{"title":"Building Number","description":"The building number. Used in SA.","type":"string"},"secondary_number":{"title":"Secondary Number","description":"The secondary number. Used in SA.","type":"string"},"neighborhood":{"title":"Neighborhood","description":"The neighborhood. Used in SA.","type":"string"},"county":{"title":"County","description":"Address county.","type":"string"},"country":{"title":"Country","description":"Address country.","type":"string"}}}}},"invoice_lines":{"type":"array","items":{"$ref":"#/definitions/PurchaseInvoiceInvoiceLine"}},"allowance_charges":{"type":"array","items":{"$ref":"#/definitions/PurchaseInvoiceAllowanceCharge"}},"document_totals":{"title":"Document Totals","description":"The total amounts for this document.","type":"object","$ref":"#/definitions/PurchaseInvoiceDocumentTotals"},"tax_subtotals":{"type":"array","items":{"$ref":"#/definitions/PurchaseInvoiceTaxSubtotal"}}}},"PurchaseInvoiceDocumentTotals":{"properties":{"total":{"title":"Total","description":"The total invoice amount, including tax. This is equal to the sum of the invoice_lines (amount_excluding_tax + tax.amount) and the allowances and charges.","type":"number"},"rounding":{"title":"Rounding","description":"The difference between the payable amount and the total invoice amount including tax.","type":"number"},"prepaid":{"title":"Prepaid","description":"The amount already paid.","type":"number"},"payable":{"title":"Payable","description":"The total invoice amount payable including tax.","type":"number"}}},"PurchaseInvoiceAccountingDetails":{"properties":{"code":{"title":"Code","description":"The the code of the general ledger account.","type":"string"},"name":{"title":"Name","description":"A textual description of the code.","type":"string"},"list":{"title":"List","description":"The name of the list for the code, e.g. \"RGS\".","type":"string"},"list_version":{"title":"List Version","description":"The version of the list for the code, e.g. \"1.1\".","type":"string"}}},"PurchaseInvoicePaymentMeans":{"properties":{"type":{"title":"Type","description":"The type of payment means. Which type are returned is determined by the &pmv= query parameter. For details see documentation for that field.","enum":["BankPaymentMean","DirectDebitPaymentMean","CardPaymentMean","NppPaymentMean","SeBankGiroPaymentMean","SePlusgiroPaymentMean","SgCardPaymentMean","SgGiroPaymentMean","SgPaynowPaymentMean","CreditTransferPaymentMean","CreditCardPaymentMean","SeBankgiroPaymentMean","AunzNppPayidPaymentMean","OnlinePaymentServicePaymentMean","StandingAgreementPaymentMean","AunzNppPaytoPaymentMean","AunzBpayPaymentMean","AunzPostbillpayPaymentMean","AunzUriPaymentMean"]},"account":{"title":"Account Number","description":"The account number to which to transfer.","type":"string"},"holder":{"title":"Account Holder","description":"The account holder name to which to transfer.","type":"string"},"branch_code":{"title":"Branch code","description":"The code identifying the bank branch. May contain a BIC/SWIFT or something appropriate for the payment method, such as \"NPP\" for type NppPaymentMean.","type":"string"},"mandate":{"title":"Mandate","description":"The mandate, used only for type DirectDebitPaymentMean.","type":"string"},"network":{"title":"Network","description":"The payment network. Used only for type CardPaymentType.","type":"string"},"payment_id":{"title":"Id","description":"The payment id to use when making the payment. The invoice sender will use this to match the received funds to the invoice.","type":"string"}}},"PurchaseInvoiceSender":{"properties":{"peppol_identifiers":{"title":"Peppol Identifiers - DEPRECATED","description":"DEPRECATED - Use the identifiers array.","type":"array","$ref":"#/definitions/PeppolIdentifier"},"party_name":{"title":"Party Name","description":"The party who sent the invoice.","type":"string"},"legal_name":{"title":"Legal Name","description":"The legal name of the party who sent the invoice.","type":"string"},"department":{"title":"Department","description":"The department who sent the invoice.","type":"string"},"line1":{"title":"Address Line 1","description":"The address","type":"string"},"line2":{"title":"Address Line 2","description":"The address, line 2","type":"string"},"zip":{"title":"Zip","description":"The zip code.","type":"string"},"city":{"title":"City","description":"The city.","type":"string"},"building_number":{"title":"Building Number","description":"The building number. Used in SA.","type":"string"},"secondary_number":{"title":"Secondary Number","description":"The secondary number. Used in SA.","type":"string"},"neighborhood":{"title":"Neighborhood","description":"The neighborhood. Used in SA.","type":"string"},"county":{"title":"County","description":"The county.","type":"string"},"country":{"title":"Country","description":"The country.","type":"string"},"billing_contact":{"title":"Billing Contact","description":"The billing contact for the invoice.","type":"object","$ref":"#/definitions/PurchaseInvoiceSenderBillingContact"},"identifiers":{"title":"Identifiers","description":"The array of identifiers for this sender.","type":"array","items":{"$ref":"#/definitions/PeppolIdentifier"}}}},"PurchaseInvoiceSenderBillingContact":{"properties":{"first_name":{"title":"First Name","description":"The first name of the billing contact.","type":"string"},"last_name":{"title":"Last Name","description":"The last name of the billing contact.","type":"string"},"email":{"title":"Email","description":"The email of the billing contact.","type":"string"}}},"PurchaseInvoiceAttachment":{"properties":{"document":{"title":"Document","description":"The Base64 encoded document attachment.","type":"string"},"content_type":{"title":"Content Type","description":"The attachment content type (mime type).","type":"string"}}},"PurchaseInvoiceAllowanceCharge":{"properties":{"amount_excluding_vat":{"title":"Amount Excluding VAT - DEPRECATED","description":"DEPRECATED - use amount_excluding_tax.","type":"string"},"vat":{"description":"DEPRECATED.","$ref":"#/definitions/PurchaseInvoiceVat"},"amount_excluding_tax":{"title":"Amount Excluding Tax","description":"The amount excluding tax.","type":"number"},"tax":{"$ref":"#/definitions/PurchaseInvoiceTax"},"reason":{"title":"AllowanceCharge reason","description":"The reason for the allowance or charge.","type":"string"}}},"PurchaseInvoiceTaxSubtotal":{"properties":{"amount_excluding_vat":{"title":"Amount Excluding VAT - DEPRECATED","description":"DEPRECATED - use amount_excluding_tax.","type":"string"},"vat":{"description":"DEPRECATED.","$ref":"#/definitions/PurchaseInvoiceVat"},"amount_excluding_tax":{"title":"Amount Excluding Tax","description":"The amount excluding tax.","type":"number"},"tax":{"$ref":"#/definitions/PurchaseInvoiceTax"}}},"PurchaseInvoiceVat":{"title":"VAT - DEPRECATED","description":"DEPRECATED - Use tax.","type":"object","properties":{"amount":{"title":"Country","description":"The VAT country.","type":"string"},"percentage":{"title":"Percentage","description":"The VAT percentage.","type":"string"}}},"PurchaseInvoiceTax":{"properties":{"tax":{"properties":{"category_code":{"title":"Category Code","description":"Deprecated. The tax category code.","type":"string"},"amount":{"title":"Amount","description":"The tax amount.","type":"number"},"percentage":{"title":"Percentage","description":"The tax percentage.","type":"number"},"country":{"title":"Country","description":"The tax country.","type":"string"},"category":{"title":"Category","description":"The tax category.","type":"string","enum":["standard","zero_rated","reverse_charge","intra_community","exempt","export","outside_scope","regulation33_exempt","nonregulation33_exempt","deemed_supply","srca_s","srca_c","not_registered","igst","cgst","sgst","cess","state_cess","srovr","srovr_rs","srovr_lvg","srlvg","sales","service","tourism","high_value_goods","low_value_goods","not_applicable"]},"type":{"title":"Type","description":"The tax type.","type":"string","enum":["VAT","GST"]}},"title":"PurchaseInvoiceTaxElement","description":"The tax element.","type":"object"}}},"PurchaseInvoiceUbl":{"properties":{"guid":{"title":"GUID","description":"The GUID of the invoice","type":"string","format":"uuid"},"tax_system":{"title":"Tax System","description":"The tax system of the invoice. Either tax_line_percentages or tax_line_amounts. The first tax system means the invoice lines contain only the tax percentages and the tax amounts are included only in the tax subtotals at the invoice level and so are only calculated at the invoice level. The tax system tax_line_amounts means that in addition to the percentage, each invoice line also contains the tax amount. The tax subtotals at the invoice level are calculated as the sum of the tax of the invoice lines. The distinction between the two tax systems has has implications for rounding.","type":"string"},"legal_entity_id":{"title":"LegalEntity id","description":"The id of the LegalEntity the invoice was received for.","type":"integer","format":"int64"},"external_user_id":{"title":"External user id","description":"Used for the embedded portal retrieval service. The external_user_id you provided when the ShopAccount was created.","type":"string"},"external_key":{"title":"External key","description":"Used for accountants. The id you specified for the organization.","type":"string"},"system_generated_primary_image":{"title":"System Generated Primary Image","description":"Whether or not the document image (PDF) was generated by Storecove. If true, it means the invoice was received without any attachments and Storecove generated one for you. If false, the invoice will contain at least one attachment, which was received from the invoice sender.","type":"boolean"},"ubl":{"title":"UBL invoice","description":"The Base64 encoded UBL invoice.","type":"string"}}},"PurchaseInvoiceInvoiceLine":{"properties":{"name":{"title":"Name","description":"A short name for the invoice line.","type":"string"},"allowance_charge":{"title":"Allowance Charge - DEPRECATED","description":"DEPRECATED - use allowance_charges.","type":"number"},"amount_excluding_vat":{"title":"DEPRECATED - use amount_excluding_tax Amount Excluding VAT","description":"DEPRECATED - use amount_excluding_tax. The amount excluding VAT.","type":"number"},"vat":{"title":"VAT Details","description":"DEPRECATED - use tax. The VAT details for the invoice line.","type":"object","properties":{"amount":{"title":"Amount","description":"The amount of VAT for the invoice line.","type":"number"},"percentage":{"title":"Percentage","description":"The percentage of VAT for the invoice line.","type":"number"},"country":{"title":"Country","description":"The ISO 3166 country of the VAT for the invoice line.","type":"string"}}},"description":{"title":"Description","description":"The description for the invoice line.","type":"string"},"period_start":{"title":"Start of Period","description":"The start date of the period this invoice line relates to. Format \"YYYY-MM-DD\".","type":"string"},"period_end":{"title":"End of Period","description":"The end date of the period this invoice line relates to. Format \"YYYY-MM-DD\".","type":"string"},"allowance_charge_array":{"type":"array","items":{"$ref":"#/definitions/PurchaseInvoiceInvoiceLineAllowanceCharge"}},"allowance_charges":{"type":"array","description":"Deprecated.","items":{"type":"number"}},"price":{"title":"Price","description":"The price for one item, excluding VAT.","$ref":"#/definitions/PurchaseInvoiceInvoiceLinePrice"},"units":{"title":"Units","description":"The number of items","$ref":"#/definitions/PurchaseInvoiceInvoiceLineItem"},"amount_excluding_tax":{"title":"Amount Excluding Tax","description":"The amount excluding Tax. This is equal to quantity x price_amount + ∑ allowance_charges.","type":"number"},"tax":{"title":"Tax Details","description":"The tax details for the invoice line.","type":"object","$ref":"#/definitions/PurchaseInvoiceTax"},"accounting":{"title":"Accounting Details","description":"The accounting details for the invoice line.","type":"object","$ref":"#/definitions/PurchaseInvoiceAccountingDetails"}}},"PurchaseInvoiceInvoiceLinePrice":{"properties":{"price_amount":{"title":"Price Amount","description":"The price for one item, excluding VAT. Can have up to digits.","type":"number"},"base_quantity":{"title":"Base Quantity","description":"The number of items the price is for. Can have up to digits.","type":"number"}}},"PurchaseInvoiceInvoiceLineAllowanceCharge":{"properties":{"amount":{"title":"Allowance or Charge","description":"The amount of the allowance or charge.","type":"number"},"reason":{"title":"Allowance or Charge Reason","description":"The reason for the allowance or charge.","type":"string"}}},"PurchaseInvoiceInvoiceLineItem":{"properties":{"quantity":{"title":"Quantity","description":"The quantity of the item. Can have up to digits.","type":"number"},"unit_code":{"title":"Unit Code","description":"The unit code of the quantity.","type":"string"}}},"WebhookInstance":{"properties":{"guid":{"title":"GUID","description":"The GUID of the WebhookInstance. Use this to delete it.","type":"string","format":"uuid"},"body":{"type":"string","title":"Body","description":"The webhook body that would have been pushed if this were a push-mode webhook."}}},"CountrySpecifications":{"properties":{"countries":{"type":"array","items":{"$ref":"#/definitions/CountrySpecification"}}}},"CountrySpecification":{"properties":{"country":{"title":"Country","description":"The ISO 3166-2 country this specification is for.","$ref":"#/definitions/Country"},"region":{"title":"Region","description":"The region this country belongs to. Within this region exchanging invoices is well defined. Between regions some care needs to be taken and Storecove may help in automatically converting some items. Contact us for details of inter-regional document exchange.","type":"string","enum":["eu_eea","sg","aunz","in","world"]},"sender":{"title":"Sender","description":"The sender of the document.","properties":{"legal":{"title":"Sender Legal Identifier","description":"The legal identifier of the sender.","type":"object","$ref":"#/definitions/CountrySpecificationIdentifier"},"tax":{"title":"Sender Tax Identifier","description":"The tax identifier of the sender.","type":"object","$ref":"#/definitions/CountrySpecificationIdentifier"}}},"receiver":{"title":"Receiver","description":"The receiver of the document.","properties":{"business":{"title":"Business Receiver","description":"The business receiver of the document.","properties":{"legal":{"title":"Business Receiver Legal Identifier","description":"The legal identifier of the business receiver.","type":"object","$ref":"#/definitions/CountrySpecificationIdentifier"},"tax":{"title":"Business Receiver Tax Identifier","description":"The tax identifier of the business receiver.","type":"object","$ref":"#/definitions/CountrySpecificationIdentifier"},"routing":{"title":"Business Receiver Routing Identifier","description":"The routing identifier of the business receiver.","type":"object","$ref":"#/definitions/CountrySpecificationIdentifier"}}},"government":{"title":"Government Receiver","description":"The government receiver of the document.","properties":{"legal":{"title":"Government Receiver Legal Identifier","description":"The legal identifier of the government receiver.","type":"object","$ref":"#/definitions/CountrySpecificationIdentifier"},"tax":{"title":"Government Receiver Tax Identifier","description":"The tax identifier of the government receiver.","type":"object","$ref":"#/definitions/CountrySpecificationIdentifier"},"routing":{"title":"Government Receiver Routing Identifier","description":"The routing identifier of the government receiver.","type":"object","$ref":"#/definitions/CountrySpecificationIdentifier"}}},"consumer":{"title":"Consumer Receiver","description":"The consumer receiver of the document.","properties":{"legal":{"title":"Consumer Receiver Legal Identifier","description":"The legal identifier of the consumer receiver.","type":"object","$ref":"#/definitions/CountrySpecificationIdentifier"},"tax":{"title":"Consumer Receiver Tax Identifier","description":"The tax identifier of the consumer receiver.","type":"object","$ref":"#/definitions/CountrySpecificationIdentifier"},"routing":{"title":"Government Receiver Routing Identifier","description":"The routing identifier of the consumer receiver.","type":"object","$ref":"#/definitions/CountrySpecificationIdentifier"}}}}}}},"CountrySpecificationIdentifier":{"properties":{"scheme_type":{"title":"Scheme Type","description":"The scheme type of the identifier. Currently always \"iso6523-actorid-upis\"","type":"string","enum":["iso6523-actorid-upis"]},"scheme":{"title":"Scheme","description":"The scheme of the identifier","type":"string"},"scheme_numercial":{"title":"Scheme Numerical","description":"The numerical version of the scheme of the identifier","type":"string"},"description":{"title":"Description","description":"Identifier description.","type":"string"},"centralized":{"title":"Centralized","description":"Whether or not the identifier represents a centralized routing identifier. This is used in SG, AT and FR where all government invoices are routed to a central accesspoint with a single identifier. This field can only be present for routing identifiers.","type":"boolean"},"centralized_identifier":{"title":"Centralized Identifier","description":"The centralized identifier to use for routing, if the \"centralized\" proprerty is true.","type":"string"},"centalized_identifier_test":{"title":"Centralized Identifier Test","description":"The centralized identifier to use for routing in test cases, if the \"centralized\" proprerty is true. May not always be available depending on the country and network.","type":"string"}}},"ReceivedDocumentCreate":{"properties":{"document":{"title":"Document","description":"The Base64 encoded document.","type":"string"},"parseStrategy":{"title":"Parse Stragegy","description":"The attachment content type (mime type).","type":"string","enum":["rfc822"]}},"required":["document","parseStrategy"]},"ReceivedDocument":{"properties":{"guid":{"title":"GUID","description":"The GUID of the received document","type":"string","format":"uuid"}}},"ErrorModel":{"properties":{"source":{"type":"string"},"details":{"type":"string"}}},"AdditionalItemProperty":{"title":"Additional Item Property","description":"An additional property for the item","type":"object","properties":{"name":{"title":"Name","description":"The name of the property.","type":"string","minLength":1},"value":{"title":"Value","description":"The value of the property.","type":"string"}},"required":["name","value"]},"Address":{"title":"Address","description":"The address","type":"object","properties":{"street1":{"title":"Street 1","description":"The street name and number. Mandatory in most countries.","type":"string","minLength":2},"street2":{"title":"Street 2","description":"The second street field. Use this if you used the first field for the building name.","type":"string"},"city":{"title":"City","description":"The name of the city. Mandatory in most countries.","type":"string","minLength":2},"zip":{"title":"Zipcode","description":"The zipcode/postalzone. Mandatory unless the country does not have zip codes.","type":"string","minLength":2},"county":{"title":"County","description":"An optional county name.","type":"string"},"country":{"$ref":"#/definitions/Country"}},"required":["country"]},"AllowanceCharge":{"title":"Allowance or Charge","type":"object","properties":{"amountExcludingVat":{"title":"Amount","description":"DEPRECATED. Use amountExcludingTax. The amount for the allowance or charge, excluding VAT.","type":"number"},"amountExcludingTax":{"title":"Amount Excluding Tax","description":"The amount for the allowance or charge, excluding tax.","type":"number"},"baseAmountExcludingTax":{"title":"Base Amount Excluding Tax","description":"The base amount for the allowance or charge, excluding tax.","type":"number"},"amountIncludingTax":{"title":"Amount Including Tax","description":"The amount for the allowance or charge, including tax.","type":"number"},"baseAmountIncludingTax":{"title":"Base Amount Including Tax","description":"The base amount for the allowance or charge, including tax.","type":"number"},"tax":{"title":"Tax","description":"DEPRECATED. Use the taxesDutiesFees array. The tax for this allowance or charge.","$ref":"#/definitions/Tax"},"taxesDutiesFees":{"title":"Taxes, Duties and Fees","description":"An array of taxes, duties and fees for this invoice line. At this moment, multiple Tax items is allowed only for IN (India) and US (USA) taxes. All other countries can only have a single Tax item in this array.","type":"array","items":{"$ref":"#/definitions/Tax"},"minItems":0},"reason":{"title":"Reason","description":"The reason for the allowance or charge, free text","type":"string","default":"Agreed settlement"},"reasonCode":{"title":"Reason Code","description":"DEPRECATED. Do not use. Contact Storecove first if you want to use this field.","type":"string"}}},"Attachment":{"title":"Invoice Attachment","description":"A document attachment to the invoice.","type":"object","properties":{"document":{"title":"Document Attachment","description":"The base64 encoded version of the document attachment.","type":"string","minLength":5},"mimeType":{"title":"Mime Type","description":"The document attachment mime type.","type":"string","enum":["text/csv","application/pdf","image/png","image/jpeg","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.oasis.opendocument.spreadsheet"]},"filename":{"title":"Filename","description":"The name of the file attachment.","type":"string","pattern":"^[\\p{L}\\p{N}\\p{M}_](?:[\\p{L}\\p{N}\\p{M}\\._-]*[\\p{L}\\p{N}\\p{M}_])?\\.[\\p{L}\\p{N}\\p{M}_-]+$"},"description":{"title":"Description","description":"A description for the file attachment.","type":"string","maxLength":1024},"documentId":{"title":"Document Id","description":"An id for the file attachment.","type":"string","maxLength":64},"primaryImage":{"title":"Primary Image","description":"DEPRECATED. Whether or not this document is a visual representation of the invoice data. Note that using value 'true' is discouraged, since the invoice data itself is leading, not the image, and including an image may lead to confusion. Peppol no longer allows including primary images.","type":"boolean","default":false}},"required":["document","mimeType"]},"C5ActivationRequest":{"title":"C5 Activation Request","description":"The C5 activation request","type":"object","properties":{"client_redirect_fail_url":{"title":"Client Redirect Fail URL","description":"The URL to redirect to in case of a C5 authorization fail.","type":"string"},"client_redirect_success_url":{"title":"Client Redirect Success URL","description":"The URL to redirect to in case of a C5 authorization success.","type":"string"},"flow_type":{"title":"Flow Type","description":"The flow type.","type":"string","enum":["flow_redirect"]},"simulate":{"title":"Simulate","description":"Whether to simulate the C5 activation.","type":"boolean"},"identifier":{"title":"Identifier","description":"The identifier.","type":"string"},"scheme":{"title":"Scheme","description":"The scheme.","type":"string","enum":["SG:UEN"]},"superscheme":{"title":"Superscheme","description":"The superscheme of the identifier. Should always be 'iso6523-actorid-upis'.","type":"string","enum":["iso6523-actorid-upis"]}},"required":["client_redirect_fail_url","client_redirect_success_url","flow_type","simulate","identifier","scheme","superscheme"]},"C5ActivationResponse":{"title":"C5 Activation Response","description":"The response to a C5 activation request","type":"object","properties":{"redirect_url":{"title":"Redirect URL","description":"The URL to redirect to","type":"string"}},"required":["redirect_url"]},"C5DeactivationRequest":{"title":"C5 Deactivation Request","description":"The C5 deactivation request","type":"object","properties":{"client_redirect_fail_url":{"title":"Client Redirect Fail URL","description":"The URL to redirect to in case of a C5 authorization fail.","type":"string"},"client_redirect_success_url":{"title":"Client Redirect Success URL","description":"The URL to redirect to in case of a C5 authorization success.","type":"string"},"flow_type":{"title":"Flow Type","description":"The flow type.","type":"string","enum":["flow_redirect"]},"simulate":{"title":"Simulate","description":"Whether to simulate the C5 deactivation.","type":"boolean"},"identifier":{"title":"Identifier","description":"The identifier.","type":"string"},"scheme":{"title":"Scheme","description":"The scheme.","type":"string","enum":["SG:UEN"]},"superscheme":{"title":"Superscheme","description":"The superscheme of the identifier. Should always be 'iso6523-actorid-upis'.","type":"string","enum":["iso6523-actorid-upis"]}},"required":["client_redirect_fail_url","client_redirect_success_url","flow_type","simulate","identifier","scheme","superscheme"]},"C5DeactivationResponse":{"title":"C5 Deactivation Response","description":"The response to a C5 deactivation request","type":"object","properties":{"redirect_url":{"title":"Redirect URL","description":"The URL to redirect to","type":"string"}},"required":["redirect_url"]},"C5EmailCancellationRequest":{"title":"C5 Email Cancellation Request","description":"The C5 email cancellation request object","type":"object","properties":{"identifier":{"title":"Identifier","description":"The identifier","type":"string"},"scheme":{"title":"Scheme","description":"The scheme","type":"string","enum":["SG:UEN"]},"superscheme":{"title":"Superscheme","description":"The superscheme","type":"string","enum":["iso6523-actorid-upis"]}},"required":["identifier","scheme","superscheme"]},"C5EmailRequest":{"title":"C5 Email Request","description":"The C5 email request object for both activation and deactivation","type":"object","properties":{"email":{"title":"Email","description":"Email of the signer","type":"string","format":"email"},"name":{"title":"Name","description":"Name of the signer","type":"string"},"identifier":{"title":"Identifier","description":"The identifier","type":"string"},"scheme":{"title":"Scheme","description":"The scheme","type":"string","enum":["SG:UEN"]},"superscheme":{"title":"Superscheme","description":"The superscheme","type":"string","enum":["iso6523-actorid-upis"]}},"required":["email","name","identifier","scheme","superscheme"]},"C5EmailResponse":{"title":"C5 Email Response","description":"The response to a C5 email request. A successful request returns 204 with no body.","type":"object","properties":{}},"C5ErrorResponse":{"title":"C5 Error Response","description":"The response to a C5 error","type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"details":{"type":"string"}},"required":["source","details"]}}},"required":["errors"]},"C5RedirectCancellationRequest":{"title":"C5 Redirect Cancellation Request","description":"The C5 redirect cancellation request object","type":"object","properties":{"identifier":{"title":"Identifier","description":"The identifier","type":"string"},"scheme":{"title":"Scheme","description":"The scheme","type":"string","enum":["SG:UEN"]},"superscheme":{"title":"Superscheme","description":"The superscheme","type":"string","enum":["iso6523-actorid-upis"]}},"required":["identifier","scheme","superscheme"]},"C5RedirectRequest":{"title":"C5 Redirect Request","description":"The C5 redirect request object for both activation and deactivation","type":"object","properties":{"client_redirect_success_url":{"title":"Client Redirect Success URL","description":"The URL to redirect to in case of a C5 authorization success","type":"string","format":"uri"},"client_redirect_fail_url":{"title":"Client Redirect Fail URL","description":"The URL to redirect to in case of a C5 authorization fail","type":"string","format":"uri"},"simulate":{"title":"Simulate","description":"Whether to simulate the C5 request","type":"boolean"},"identifier":{"title":"Identifier","description":"The identifier","type":"string"},"scheme":{"title":"Scheme","description":"The scheme","type":"string","enum":["SG:UEN"]},"superscheme":{"title":"Superscheme","description":"The superscheme","type":"string","enum":["iso6523-actorid-upis"]}},"required":["client_redirect_success_url","client_redirect_fail_url","identifier","scheme","superscheme"]},"C5RedirectResponse":{"title":"C5 Redirect Response","description":"The response to a C5 redirect request","type":"object","properties":{"redirect_url":{"title":"Redirect URL","description":"The URL to redirect to","type":"string","format":"uri"}},"required":["redirect_url"]},"Country":{"title":"Country","description":"An ISO 3166-1 alpha-2 country code.","type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW","XK","XI"]},"CurrencyCode":{"title":"Currency","description":"The ISO 4217 currency code.","type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNH","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","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","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STN","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UZS","VED","VES","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XFU","XOF","XPD","XPF","XPT","XSU","XTS","XUA","XXX","YER","ZAR","ZMW"]},"Delivery":{"type":"object","properties":{"deliveryLocation":{"type":"object","properties":{"id":{"title":"Identifier","description":"The location identifier.","type":"string","minLength":2},"schemeId":{"title":"Identifier Scheme ID","description":"The schemeId of the location identifier (e.g. 'EAN')","type":"string"},"schemeAgencyId":{"title":"Identifier Scheme Agency ID","description":"DEPRECATED. The schemeAgencyId of the location identifier (e.g. 'ZZZ')","type":"string"},"locationName":{"title":"Location Name","description":"The name of the delivery location. Only used for DocumentOrder.","type":"string","maxLength":128},"address":{"$ref":"#/definitions/Address","description":"The address of the delivery location."}}},"requestedDeliveryPeriod":{"title":"Requested Delivery Period","description":"The requested delivery period. Used only for DocumentOrder. Will also be used for DocumentOrder order lines, if that order line does not specify its own delivery period.","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2} - [0-9]{4}-[0-9]{2}-[0-9]{2}$"},"actualDeliveryDate":{"title":"Actual Delivery Date","description":"The actual date of the delivery. Used only for Invoice","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},"quantity":{"title":"Quantity","description":"The quantity of the delivery. Used only for Invoice","type":"number","default":1.0},"deliveryPartyName":{"title":"Delivery Party Name","description":"DEPRECATED. Use deliveryParty. The name of the party that took delivery. Used only for Invoice","type":"string"},"deliveryParty":{"description":"The party to whom the delivery takes place.","$ref":"#/definitions/DeliveryParty"},"shipment":{"description":"The shipment for the delivery.","$ref":"#/definitions/Shipment"},"shippingMarks":{"title":"Shipping Marks","description":"DEPRECATED. Use the shipment object. A text that the buyer requests to be printed on the packing labels. Used only for DocumentOrder.","type":"string","maxLength":128}}},"DeliveryTerms":{"type":"object","properties":{"incoterms":{"title":"Incoterms","description":"The incoterms:\n++++\n<ul>    <li>        <strong>EXW – Ex Works</strong><br/>        The seller must give the buyer access to goods at an agreed location. From that moment, the buyer bears almost all costs and risks during the entire shipping process.<br/>    </li>    <li>        <strong>FCA – Free Carrier</strong><br/>        The seller must make the goods available at his own risk and expense at his own premises or at an agreed place. In both cases, the seller is responsible for the clearance of the goods for export. It can be agreed that the buyer must instruct the carrier to transfer a “Bill of Lading (BL)” with a note on board to the seller.    </li>    <li>        <strong>CPT – Carriage Paid To</strong><br/>        The seller has the same responsibilities as with FCA, but in this case also pays the delivery costs.    </li>    <li>        <strong>CIP – Carriage Insurance Paid To</strong><br/>        The same seller responsibilities as with CPT, only in this case the seller is obliged to pay the insurance with a high coverage ratio. Parties can agree separately to apply limited coverage.    </li>    <li>        <strong>DAP – Delivered At Place</strong><br/>        The seller bears the costs and risks during the transport of the goods to an agreed address. As soon as the goods have arrived at this address and are ready for unloading, the risk passes to the buyer.    </li>    <li>        <strong>DPU – Delivered at Place Unloaded</strong><br/>        The seller is responsible for the costs and risks of delivering goods to an agreed destination where goods can be unloaded for further transport. The selling party arranges customs and unloads the goods at the agreed place. The buyer arranges the customs clearance and any associated rights.    </li>    <li>        <strong>DDP – Delivered Duty Paid</strong><br/>        The seller bears the costs and risks of transport, carries out the export and import responsibilities and pays any import duties. As soon as the goods have arrived at the address and are ready for unloading, the risk passes to the buyer.    </li>    <li>        <strong>FAS – Free Alongside Ship</strong><br/>        The seller bears all costs and risks until the goods are delivered next to the ship. From that point, the risk is for the buyer and he also arranges the export clearance and import clearance.    </li>    <li>        <strong>FOB – Free On Board</strong><br/>        The seller bears all costs and risks until the goods are on board the ship and also arranges the export clearance. As soon as the goods have been delivered to the ship, the buyer bears all responsibilities.    </li>    <li>        <strong>CFR – Cost And Freight</strong><br/>        The same applies to the seller and buyer as with FOB, but in this case, the seller must also pay for the transport of the goods to the port.    </li>    <li>        <strong>CIF – Cost, Insurance, and Freight</strong><br/>        The seller has the same obligations as with CFR but also pays the (minimum) insurance costs. The buyer must pay for more comprehensive insurance.    </li></ul>\n++++","type":"string","enum":["EXW","FCA","CPT","CIP","DAP","DPU","DDP","FAS","FOB","CFR","CIF"]},"specialTerms":{"title":"Special Terms","description":"A description of special conditions relating to the delivery terms.","type":"string","maxLength":512},"deliveryLocationId":{"title":"Delivery Location Id","description":"The location to which the delivery terms refer.","type":"string","maxLength":128}}},"LineDelivery":{"type":"object","properties":{"deliveryLocation":{"type":"object","properties":{"id":{"title":"Identifier","description":"The location identifier.","type":"string","minLength":2},"schemeId":{"title":"Identifier Scheme ID","description":"The schemeId of the location identifier (e.g. '0088')","type":"string"},"requestedDeliveryPeriod":{"title":"Requested Delivery Period","description":"The requested delivery period. If not present, will be taken from the document level. If that is not present, this field is mandatory.","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2} - [0-9]{4}-[0-9]{2}-[0-9]{2}$"}}}}},"Shipment":{"type":"object","properties":{"shippingMarks":{"title":"Shipping Marks","description":"A text that the buyer requests to be printed on the packing labels. Used only for DocumentOrder.","type":"string","maxLength":128},"originAddress":{"title":"Origin Address","description":"The address from which the shipment is being sent. Currently supports country only.","$ref":"#/definitions/Address"},"allowanceCharges":{"title":"Allowance Charges","description":"A list of charges","type":"array","items":{"$ref":"#/definitions/AllowanceCharge"}}}},"DiscoveryFlag":{"title":"DiscoveryFlag","description":"A flag to filter for documents","type":"object","properties":{"supportsSelfBilling":{"title":"Supports Self Billing","description":"Whether or not to filter for documents that support self billing.","type":"string","enum":["allowed","required","not_allowed"],"default":"not_allowed"}}},"DocumentInvoiceReport":{"title":"Document Invoice Report","description":"The invoice report to send.","type":"object","properties":{"action":{"title":"Action","description":"The action to take.","type":"string","pattern":"^send$"}},"required":["action"]},"DocumentInvoiceResponse":{"title":"Document Invoice Response","description":"The invoice response to send or received.","type":"object","properties":{"clarifications":{"title":"Clarifications","description":"A list of clarifications why a received invoice was rejected (RE) or under query (UQ) and what action to take.","type":"array","items":{"$ref":"#/definitions/InvoiceResponseClarification"},"minItems":0},"effectiveDate":{"title":"Effective Date","description":"The date when the status became effective. Format: yyyy-mm-dd.","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},"note":{"title":"Note","description":"A note to add to the invoice reponse","type":"string"},"responseCode":{"title":"Response Code","description":"The response code. For details see https://docs.peppol.eu/poacc/upgrade-3/codelist/UNCL4343-T111/","type":"string","enum":["AB","IP","UQ","CA","RE","AP","PD"]}},"required":["receivedInvoiceGuid","responseCode"]},"InvoiceResponseClarification":{"title":"Invoice Response Clarification","description":"A clarification for why a received invoice was rejected (RE) or under query (UQ) and what action to take.","type":"object","properties":{"clarificationCodeType":{"title":"Clarification Code Type","description":"The type of the clarification.","type":"string","enum":["OPStatusReason","OPStatusAction"]},"clarificationCode":{"title":"Clarification Code","description":"The code for the clarification. For details see https://docs.peppol.eu/poacc/upgrade-3/codelist/OPStatusReason/ and https://docs.peppol.eu/poacc/upgrade-3/codelist/OPStatusAction/","type":"string","enum":["NON","REF","LEG","REC","QUA","DEL","PRI","QTY","ITM","PAY","UNR","FIN","PPD","OTH","NOA","PIN","NIN","CNF","CNP","CNA"]},"clarification":{"title":"Clarification","description":"A textual description of the clarification","type":"string"},"conditions":{"title":"Conditions","description":"A list of conditions that triggered the error. This is only included for receiving in webhooks. You cannot currently send these conditions.","type":"array","items":{"$ref":"#/definitions/InvoiceResponseCondition"},"minItems":0}}},"InvoiceResponseCondition":{"title":"Invoice Response Condition","description":"Specifies an error in the received invoice.","type":"object","properties":{"fieldCode":{"title":"Field Code","description":"The code of the field with the error. Find the element here: https://docs.peppol.eu/poacc/billing/3.0/syntax/ubl-invoice/ and then get the field's Business term.","type":"string"},"fieldValue":{"title":"Field value","description":"The (error) value of the field.","type":"string"}},"required":["fieldCode","fieldValue"]},"DocumentOrder":{"title":"Order","description":"The order to send.","type":"object","properties":{"taxSystem":{"title":"Tax System","description":"The tax system used for the invoice. The system 'tax_line_percentages' is the only one currently supported.","type":"string","enum":["tax_line_percentages"],"default":"tax_line_percentages"},"documentNumber":{"title":"Document number","description":"The number you assigned to the document.","type":"string","minLength":1},"references":{"title":"References","description":"An array of references to other documents. Note that many syntaxes do not support multiple references of the same type in which case they will be concatenated with ','. Also, not all syntaxes and doucments support all documentTypes.","type":"array","items":{"$ref":"#/definitions/Reference"},"minItems":0},"issueDate":{"title":"Document issue date","description":"Format: yyyy-mm-dd.","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},"issueTime":{"title":"Document issue time","description":"Format: hh:mm:ss","type":"string","pattern":"^[0-9]{2}:[0-9]{2}:[0-9]{2}$"},"timeZone":{"title":"Document issue timezone","description":"Format: ±zzzz, where ±zzzz is the difference from UTC, e.g. +0100 or -0900 etc. The timezone will also apply to the document issue date if this field is provided.","type":"string","pattern":"^[+-]\\d{4}$"},"orderType":{"title":"Order Type","description":"The type of this order.","type":"string","enum":["regular","consignment"],"default":"regular"},"note":{"title":"Note","description":"A note to add to the document","type":"string","maxLength":255},"documentCurrencyCode":{"description":"The documentCurrencyCode is the currency for the entire invoice. We currently do not support invoices in multiple currencies. If left out, will default to EUR","$ref":"#/definitions/CurrencyCode","default":"EUR"},"accountingCost":{"title":"Accounting Cost","description":"The buyer's accounting cost centre for this document.","type":"string","minLength":1},"validityPeriod":{"title":"Validity period","description":"The period (or specific date) to which the invoice applies. Format: yyyy-mm-dd - yyyy-mm-dd.","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2} - [0-9]{4}-[0-9]{2}-[0-9]{2}$"},"buyerCustomerParty":{"description":"The party sending the order. Most data for the BuyerCustomerParty is taken from the Storecove database, where your sender identity resides and has been validated. However, we provide a limited number of fields (mainly contact fields) here that you can specify on a document-by-document basis.","$ref":"#/definitions/BuyerCustomerPartyOrder"},"sellerSupplierParty":{"description":"The seller supplier party. This info will be added to the LegalEntity provided through the legalEntityId.","$ref":"#/definitions/SellerSupplierParty"},"delivery":{"title":"Delivery","description":"The delivery information for the document.","$ref":"#/definitions/Delivery"},"deliveryTerms":{"title":"Delivery Terms","description":"The terms of delivery for the document.","$ref":"#/definitions/DeliveryTerms"},"paymentTerms":{"title":"Payment Terms","description":"The payment terms of the document.","$ref":"#/definitions/PaymentTerms"},"allowanceCharges":{"title":"Allowance Charges","description":"An array of allowance charges.","type":"array","items":{"$ref":"#/definitions/AllowanceCharge"},"minItems":0},"orderLines":{"title":"Order lines","description":"An array of order lines.","type":"array","items":{"$ref":"#/definitions/OrderLine"},"minItems":1},"amountIncludingTax":{"title":"Amount including Tax","description":"Total amount including Tax.","type":"number"},"attachments":{"title":"Attachments","description":"An array of attachments. You may provide up to 10 attchments, but the total size must not exceed 100MB after Base64 encoding.","type":"array","maxItems":10,"items":{"$ref":"#/definitions/Attachment"}}},"required":["documentNumber","issueDate","sellerSupplierParty","orderLines","amountIncludingTax"]},"OrderLine":{"title":"Order line","type":"object","properties":{"lineId":{"title":"Invoice Line ID","description":"The id for this invoice line.","type":"string","minLength":1},"quantity":{"title":"Quantity","description":"The number of items (may be fractional).","type":"number","default":1.0},"quantityUnitCode":{"title":"Quantity Unit Code","description":"The unit of measure that applies to the quantity. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the \"Intro\" section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. To avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure. Note that the following additionally allowed codes are deprecated and will be converted to C62: 04, 05, 08, 16, 17, 18, 19, 26, 29, 30, 31, 32, 36, 43, 44, 45, 46, 47, 48, 53, 54, 62, 63, 64, 66, 69, 71, 72, 73, 76, 78, 84, 90, 92, 93, 94, 95, 96, 97, 98, 1A, 1B, 1C, 1D, 1E, 1F, 1G, 1H, 1J, 1K, 1L, 1M, 1X, 2V, 2W, 3E, 3G, 3H, 3I, 4A, 4B, 4E, 5C, 5F, 5G, 5H, 5I, 5K, 5P, 5Q, A1, A25, A50, A51, A52, A57, A58, A60, A61, A62, A63, A64, A65, A66, A67, A77, A78, A79, A80, A81, A82, A83, AJ, AM, AP, AR, ARE, ATT, AV, AW, B0, B2, B36, B37, B38, B39, B40, B5, B51, B6, B65, B9, BD, BE, BG, BH, BJ, BK, BL, BO, BR, BT, BW, BX, BZ, C1, C2, C4, C5, C6, C77, C98, CA, CH, CJ, CK, CL, CO, CQ, CR, CS, CT, CU, CV, CY, CZ, D14, D28, D35, D37, D38, D39, D40, D64, D66, D67, D7, D70, D71, D72, D75, D76, D79, D8, D9, D90, D92, D96, D97, D98, D99, DC, DE, DI, DQ, DR, DRM, DS, DU, DX, DY, E2, E3, E5, EC, EP, EV, F1, F9, FB, FD, FE, FG, FM, G7, GC, GD, GH, GK, GN, GRT, GT, GW, GY, GZ, H1, H2, HAR, HD, HE, HF, HI, HJ, HK, HL, HN, HO, HP, HS, HT, HY, IC, IF, II, IL, IM, IP, IT, JB, JG, JO, JR, K5, KD, KF, KG, KS, KTM, LC, LE, LI, LJ, LX, M0, MA, MF, MK, MQ, MT, MV, N2, NB, NBB, NC, ND, NE, NG, NH, NI, NJ, NN, NPL, NPR, NQ, NR, NRL, NTT, NV, NY, OP, OZ, P0, P3, P4, P6, P7, P8, P9, PA, PB, PE, PF, PG, PK, PL, PM, PN, PT, PU, PV, PW, PY, PZ, QD, QH, QK, QT, R4, RA, RD, RG, RK, RL, RN, RO, RS, RU, S5, S6, S7, S8, SA, SD, SE, SHT, SK, SL, SN, SO, SP, SS, SST, ST, SV, T1, T4, T5, T6, T7, T8, TA, TC, TD, TE, TF, TJ, TK, TL, TN, TQ, TR, TS, TSD, TSH, TT, TU, TV, TW, TY, UA, UD, UE, UF, UH, UM, VI, VQ, VS, W4, WH, WI, WR, WW, YL, YT, Z1, Z2, Z3, Z4, Z5, Z6, Z8","type":"string","enum":["10","11","13","14","15","20","21","22","23","24","25","27","28","33","34","35","37","38","40","41","56","57","58","59","60","61","74","77","80","81","85","87","89","91","1I","2A","2B","2C","2G","2H","2I","2J","2K","2L","2M","2N","2P","2Q","2R","2U","2X","2Y","2Z","3B","3C","4C","4G","4H","4K","4L","4M","4N","4O","4P","4Q","4R","4T","4U","4W","4X","5A","5B","5E","5J","A10","A11","A12","A13","A14","A15","A16","A17","A18","A19","A2","A20","A21","A22","A23","A24","A26","A27","A28","A29","A3","A30","A31","A32","A33","A34","A35","A36","A37","A38","A39","A4","A40","A41","A42","A43","A44","A45","A47","A48","A49","A5","A53","A54","A55","A56","A59","A6","A68","A69","A7","A70","A71","A73","A74","A75","A76","A8","A84","A85","A86","A87","A88","A89","A9","A90","A91","A93","A94","A95","A96","A97","A98","A99","AA","AB","ACR","ACT","AD","AE","AH","AI","AK","AL","AMH","AMP","ANN","APZ","AQ","AS","ASM","ASU","ATM","AWG","AY","AZ","B1","B10","B11","B12","B13","B14","B15","B16","B17","B18","B19","B20","B21","B22","B23","B24","B25","B26","B27","B28","B29","B3","B30","B31","B32","B33","B34","B35","B4","B41","B42","B43","B44","B45","B46","B47","B48","B49","B50","B52","B53","B54","B55","B56","B57","B58","B59","B60","B61","B62","B63","B64","B66","B67","B68","B69","B7","B70","B71","B72","B73","B74","B75","B76","B77","B78","B79","B8","B80","B81","B82","B83","B84","B85","B86","B87","B88","B89","B90","B91","B92","B93","B94","B95","B96","B97","B98","B99","BAR","BB","BFT","BHP","BIL","BLD","BLL","BP","BPM","BQL","BTU","BUA","BUI","C0","C10","C11","C12","C13","C14","C15","C16","C17","C18","C19","C20","C21","C22","C23","C24","C25","C26","C27","C28","C29","C3","C30","C31","C32","C33","C34","C35","C36","C37","C38","C39","C40","C41","C42","C43","C44","C45","C46","C47","C48","C49","C50","C51","C52","C53","C54","C55","C56","C57","C58","C59","C60","C61","C62","C63","C64","C65","C66","C67","C68","C69","C7","C70","C71","C72","C73","C74","C75","C76","C78","C79","C8","C80","C81","C82","C83","C84","C85","C86","C87","C88","C89","C9","C90","C91","C92","C93","C94","C95","C96","C97","C99","CCT","CDL","CEL","CEN","CG","CGM","CKG","CLF","CLT","CMK","CMQ","CMT","CNP","CNT","COU","CTG","CTM","CTN","CUR","CWA","CWI","D03","D04","D1","D10","D11","D12","D13","D15","D16","D17","D18","D19","D2","D20","D21","D22","D23","D24","D25","D26","D27","D29","D30","D31","D32","D33","D34","D36","D41","D42","D43","D44","D45","D46","D47","D48","D49","D5","D50","D51","D52","D53","D54","D55","D56","D57","D58","D59","D6","D60","D61","D62","D63","D65","D68","D69","D73","D74","D77","D78","D80","D81","D82","D83","D85","D86","D87","D88","D89","D91","D93","D94","D95","DAA","DAD","DAY","DB","DD","DEC","DG","DJ","DLT","DMA","DMK","DMO","DMQ","DMT","DN","DPC","DPR","DPT","DRA","DRI","DRL","DT","DTN","DWT","DZN","DZP","E01","E07","E08","E09","E10","E12","E14","E15","E16","E17","E18","E19","E20","E21","E22","E23","E25","E27","E28","E30","E31","E32","E33","E34","E35","E36","E37","E38","E39","E4","E40","E41","E42","E43","E44","E45","E46","E47","E48","E49","E50","E51","E52","E53","E54","E55","E56","E57","E58","E59","E60","E61","E62","E63","E64","E65","E66","E67","E68","E69","E70","E71","E72","E73","E74","E75","E76","E77","E78","E79","E80","E81","E82","E83","E84","E85","E86","E87","E88","E89","E90","E91","E92","E93","E94","E95","E96","E97","E98","E99","EA","EB","EQ","F01","F02","F03","F04","F05","F06","F07","F08","F10","F11","F12","F13","F14","F15","F16","F17","F18","F19","F20","F21","F22","F23","F24","F25","F26","F27","F28","F29","F30","F31","F32","F33","F34","F35","F36","F37","F38","F39","F40","F41","F42","F43","F44","F45","F46","F47","F48","F49","F50","F51","F52","F53","F54","F55","F56","F57","F58","F59","F60","F61","F62","F63","F64","F65","F66","F67","F68","F69","F70","F71","F72","F73","F74","F75","F76","F77","F78","F79","F80","F81","F82","F83","F84","F85","F86","F87","F88","F89","F90","F91","F92","F93","F94","F95","F96","F97","F98","F99","FAH","FAR","FBM","FC","FF","FH","FIT","FL","FOT","FP","FR","FS","FTK","FTQ","G01","G04","G05","G06","G08","G09","G10","G11","G12","G13","G14","G15","G16","G17","G18","G19","G2","G20","G21","G23","G24","G25","G26","G27","G28","G29","G3","G30","G31","G32","G33","G34","G35","G36","G37","G38","G39","G40","G41","G42","G43","G44","G45","G46","G47","G48","G49","G50","G51","G52","G53","G54","G55","G56","G57","G58","G59","G60","G61","G62","G63","G64","G65","G66","G67","G68","G69","G70","G71","G72","G73","G74","G75","G76","G77","G78","G79","G80","G81","G82","G83","G84","G85","G86","G87","G88","G89","G90","G91","G92","G93","G94","G95","G96","G97","G98","G99","GB","GBQ","GDW","GE","GF","GFI","GGR","GIA","GIC","GII","GIP","GJ","GL","GLD","GLI","GLL","GM","GO","GP","GQ","GRM","GRN","GRO","GV","GWH","H03","H04","H05","H06","H07","H08","H09","H10","H11","H12","H13","H14","H15","H16","H18","H19","H20","H21","H22","H23","H24","H25","H26","H27","H28","H29","H30","H31","H32","H33","H34","H35","H36","H37","H38","H39","H40","H41","H42","H43","H44","H45","H46","H47","H48","H49","H50","H51","H52","H53","H54","H55","H56","H57","H58","H59","H60","H61","H62","H63","H64","H65","H66","H67","H68","H69","H70","H71","H72","H73","H74","H75","H76","H77","H79","H80","H81","H82","H83","H84","H85","H87","H88","H89","H90","H91","H92","H93","H94","H95","H96","H98","H99","HA","HBA","HBX","HC","HDW","HEA","HGM","HH","HIU","HKM","HLT","HM","HMQ","HMT","HPA","HTZ","HUR","IA","IE","INH","INK","INQ","ISD","IU","IV","J10","J12","J13","J14","J15","J16","J17","J18","J19","J2","J20","J21","J22","J23","J24","J25","J26","J27","J28","J29","J30","J31","J32","J33","J34","J35","J36","J38","J39","J40","J41","J42","J43","J44","J45","J46","J47","J48","J49","J50","J51","J52","J53","J54","J55","J56","J57","J58","J59","J60","J61","J62","J63","J64","J65","J66","J67","J68","J69","J70","J71","J72","J73","J74","J75","J76","J78","J79","J81","J82","J83","J84","J85","J87","J90","J91","J92","J93","J95","J96","J97","J98","J99","JE","JK","JM","JNT","JOU","JPS","JWL","K1","K10","K11","K12","K13","K14","K15","K16","K17","K18","K19","K2","K20","K21","K22","K23","K26","K27","K28","K3","K30","K31","K32","K33","K34","K35","K36","K37","K38","K39","K40","K41","K42","K43","K45","K46","K47","K48","K49","K50","K51","K52","K53","K54","K55","K58","K59","K6","K60","K61","K62","K63","K64","K65","K66","K67","K68","K69","K70","K71","K73","K74","K75","K76","K77","K78","K79","K80","K81","K82","K83","K84","K85","K86","K87","K88","K89","K90","K91","K92","K93","K94","K95","K96","K97","K98","K99","KA","KAT","KB","KBA","KCC","KDW","KEL","KGM","KGS","KHY","KHZ","KI","KIC","KIP","KJ","KJO","KL","KLK","KLX","KMA","KMH","KMK","KMQ","KMT","KNI","KNM","KNS","KNT","KO","KPA","KPH","KPO","KPP","KR","KSD","KSH","KT","KTN","KUR","KVA","KVR","KVT","KW","KWH","KWO","KWT","KX","L10","L11","L12","L13","L14","L15","L16","L17","L18","L19","L2","L20","L21","L23","L24","L25","L26","L27","L28","L29","L30","L31","L32","L33","L34","L35","L36","L37","L38","L39","L40","L41","L42","L43","L44","L45","L46","L47","L48","L49","L50","L51","L52","L53","L54","L55","L56","L57","L58","L59","L60","L63","L64","L65","L66","L67","L68","L69","L70","L71","L72","L73","L74","L75","L76","L77","L78","L79","L80","L81","L82","L83","L84","L85","L86","L87","L88","L89","L90","L91","L92","L93","L94","L95","L96","L98","L99","LA","LAC","LBR","LBT","LD","LEF","LF","LH","LK","LM","LN","LO","LP","LPA","LR","LS","LTN","LTR","LUB","LUM","LUX","LY","M1","M10","M11","M12","M13","M14","M15","M16","M17","M18","M19","M20","M21","M22","M23","M24","M25","M26","M27","M29","M30","M31","M32","M33","M34","M35","M36","M37","M38","M39","M4","M40","M41","M42","M43","M44","M45","M46","M47","M48","M49","M5","M50","M51","M52","M53","M55","M56","M57","M58","M59","M60","M61","M62","M63","M64","M65","M66","M67","M68","M69","M7","M70","M71","M72","M73","M74","M75","M76","M77","M78","M79","M80","M81","M82","M83","M84","M85","M86","M87","M88","M89","M9","M90","M91","M92","M93","M94","M95","M96","M97","M98","M99","MAH","MAL","MAM","MAR","MAW","MBE","MBF","MBR","MC","MCU","MD","MGM","MHZ","MIK","MIL","MIN","MIO","MIU","MLD","MLT","MMK","MMQ","MMT","MND","MON","MPA","MQH","MQS","MSK","MTK","MTQ","MTR","MTS","MVA","MWH","N1","N10","N11","N12","N13","N14","N15","N16","N17","N18","N19","N20","N21","N22","N23","N24","N25","N26","N27","N28","N29","N3","N30","N31","N32","N33","N34","N35","N36","N37","N38","N39","N40","N41","N42","N43","N44","N45","N46","N47","N48","N49","N50","N51","N52","N53","N54","N55","N56","N57","N58","N59","N60","N61","N62","N63","N64","N65","N66","N67","N68","N69","N70","N71","N72","N73","N74","N75","N76","N77","N78","N79","N80","N81","N82","N83","N84","N85","N86","N87","N88","N89","N90","N91","N92","N93","N94","N95","N96","N97","N98","N99","NA","NAR","NCL","NEW","NF","NIL","NIU","NL","NM3","NMI","NMP","NPT","NT","NU","NX","OA","ODE","OHM","ON","ONZ","OPM","OT","OZA","OZI","P1","P10","P11","P12","P13","P14","P15","P16","P17","P18","P19","P2","P20","P21","P22","P23","P24","P25","P26","P27","P28","P29","P30","P31","P32","P33","P34","P35","P36","P37","P38","P39","P40","P41","P42","P43","P44","P45","P46","P47","P48","P49","P5","P50","P51","P52","P53","P54","P55","P56","P57","P58","P59","P60","P61","P62","P63","P64","P65","P66","P67","P68","P69","P70","P71","P72","P73","P74","P75","P76","P77","P78","P79","P80","P81","P82","P83","P84","P85","P86","P87","P88","P89","P90","P91","P92","P93","P94","P95","P96","P97","P98","P99","PAL","PD","PFL","PGL","PI","PLA","PO","PQ","PR","PS","PTD","PTI","PTL","PTN","Q10","Q11","Q12","Q13","Q14","Q15","Q16","Q17","Q18","Q19","Q20","Q21","Q22","Q23","Q24","Q25","Q26","Q27","Q28","Q29","Q30","Q31","Q32","Q33","Q34","Q35","Q36","Q37","Q38","Q39","Q40","Q3","QA","QAN","QB","QR","QTD","QTI","QTL","QTR","R1","R9","RH","RM","ROM","RP","RPM","RPS","RT","S3","S4","SAN","SCO","SCR","SEC","SET","SG","SIE","SM3","SMI","SQ","SQR","SR","STC","STI","STK","STL","STN","STW","SW","SX","SYR","T0","T3","TAH","TAN","TI","TIC","TIP","TKM","TMS","TNE","TP","TPI","TPR","TQD","TRL","TST","TTS","U1","U2","UB","UC","VA","VLT","VP","W2","WA","WB","WCD","WE","WEB","WEE","WG","WHR","WM","WSD","WTT","X1","YDK","YDQ","YRD","Z11","ZP","ZZ","X1A","X1B","X1D","X1F","X1G","X1W","X2C","X3A","X3H","X43","X44","X4A","X4B","X4C","X4D","X4F","X4G","X4H","X5H","X5L","X5M","X6H","X6P","X7A","X7B","X8A","X8B","X8C","XAA","XAB","XAC","XAD","XAE","XAF","XAG","XAH","XAI","XAJ","XAL","XAM","XAP","XAT","XAV","XB4","XBA","XBB","XBC","XBD","XBE","XBF","XBG","XBH","XBI","XBJ","XBK","XBL","XBM","XBN","XBO","XBP","XBQ","XBR","XBS","XBT","XBU","XBV","XBW","XBX","XBY","XBZ","XCA","XCB","XCC","XCD","XCE","XCF","XCG","XCH","XCI","XCJ","XCK","XCL","XCM","XCN","XCO","XCP","XCQ","XCR","XCS","XCT","XCU","XCV","XCW","XCX","XCY","XCZ","XDA","XDB","XDC","XDG","XDH","XDI","XDJ","XDK","XDL","XDM","XDN","XDP","XDR","XDS","XDT","XDU","XDV","XDW","XDX","XDY","XEC","XED","XEE","XEF","XEG","XEH","XEI","XEN","XFB","XFC","XFD","XFE","XFI","XFL","XFO","XFP","XFR","XFT","XFW","XFX","XGB","XGI","XGL","XGR","XGU","XGY","XGZ","XHA","XHB","XHC","XHG","XHN","XHR","XIA","XIB","XIC","XID","XIE","XIF","XIG","XIH","XIK","XIL","XIN","XIZ","XJB","XJC","XJG","XJR","XJT","XJY","XKG","XKI","XLE","XLG","XLT","XLU","XLV","XLZ","XMA","XMB","XMC","XME","XMR","XMS","XMT","XMW","XMX","XNA","XNE","XNF","XNG","XNS","XNT","XNU","XNV","XOA","XOB","XOC","XOD","XOE","XOF","XOK","XOT","XOU","XP2","XPA","XPB","XPC","XPD","XPE","XPF","XPG","XPH","XPI","XPJ","XPK","XPL","XPN","XPO","XPP","XPR","XPT","XPU","XPV","XPX","XPY","XPZ","XQA","XQB","XQC","XQD","XQF","XQG","XQH","XQJ","XQK","XQL","XQM","XQN","XQP","XQQ","XQR","XQS","XRD","XRG","XRJ","XRK","XRL","XRO","XRT","XRZ","XSA","XSB","XSC","XSD","XSE","XSH","XSI","XSK","XSL","XSM","XSO","XSP","XSS","XST","XSU","XSV","XSW","XSY","XSZ","XT1","XTB","XTC","XTD","XTE","XTG","XTI","XTK","XTL","XTN","XTO","XTR","XTS","XTT","XTU","XTV","XTW","XTY","XTZ","XUC","XUN","XVA","XVG","XVI","XVK","XVL","XVO","XVP","XVQ","XVN","XVR","XVS","XVY","XWA","XWB","XWC","XWD","XWF","XWG","XWH","XWJ","XWK","XWL","XWM","XWN","XWP","XWQ","XWR","XWS","XWT","XWU","XWV","XWW","XWX","XWY","XWZ","XXA","XXB","XXC","XXD","XXF","XXG","XXH","XXJ","XXK","XYA","XYB","XYC","XYD","XYF","XYG","XYH","XYJ","XYK","XYL","XYM","XYN","XYP","XYQ","XYR","XYS","XYT","XYV","XYW","XYX","XYY","XYZ","XZA","XZB","XZC","XZD","XZF","XZG","XZH","XZJ","XZK","XZL","XZM","XZN","XZP","XZQ","XZR","XZS","XZT","XZU","XZV","XZW","XZX","XZY","XZZ","04","05","08","16","17","18","19","26","29","30","31","32","36","43","44","45","46","47","48","53","54","62","63","64","66","69","71","72","73","76","78","84","90","92","93","94","95","96","97","98","1A","1B","1C","1D","1E","1F","1G","1H","1J","1K","1L","1M","1X","2V","2W","3E","3G","3H","3I","4A","4B","4E","5C","5F","5G","5H","5I","5K","5P","5Q","A1","A25","A50","A51","A52","A57","A58","A60","A61","A62","A63","A64","A65","A66","A67","A77","A78","A79","A80","A81","A82","A83","AJ","AM","AP","AR","ARE","ATT","AV","AW","B0","B2","B36","B37","B38","B39","B40","B5","B51","B6","B65","B9","BD","BE","BG","BH","BJ","BK","BL","BO","BR","BT","BW","BX","BZ","C1","C2","C4","C5","C6","C77","C98","CA","CH","CJ","CK","CL","CO","CQ","CR","CS","CT","CU","CV","CY","CZ","D14","D28","D35","D37","D38","D39","D40","D64","D66","D67","D7","D70","D71","D72","D75","D76","D79","D8","D9","D90","D92","D96","D97","D98","D99","DC","DE","DI","DQ","DR","DRM","DS","DU","DX","DY","E2","E3","E5","EC","EP","EV","F1","F9","FB","FD","FE","FG","FM","G7","GC","GD","GH","GK","GN","GRT","GT","GW","GY","GZ","H1","H2","HAR","HD","HE","HF","HI","HJ","HK","HL","HN","HO","HP","HS","HT","HY","IC","IF","II","IL","IM","IP","IT","JB","JG","JO","JR","K5","KD","KF","KG","KS","KTM","LC","LE","LI","LJ","LX","M0","MA","MF","MK","MQ","MT","MV","N2","NB","NBB","NC","ND","NE","NG","NH","NI","NJ","NN","NPL","NPR","NQ","NR","NRL","NTT","NV","NY","OP","OZ","P0","P3","P4","P6","P7","P8","P9","PA","PB","PE","PF","PG","PK","PL","PM","PN","PT","PU","PV","PW","PY","PZ","QD","QH","QK","QT","R4","RA","RD","RG","RK","RL","RN","RO","RS","RU","S5","S6","S7","S8","SA","SD","SE","SHT","SK","SL","SN","SO","SP","SS","SST","ST","SV","T1","T4","T5","T6","T7","T8","TA","TC","TD","TE","TF","TJ","TK","TL","TN","TQ","TR","TS","TSD","TSH","TT","TU","TV","TW","TY","UA","UD","UE","UF","UH","UM","VI","VQ","VS","W4","WH","WI","WR","WW","YL","YT","Z1","Z2","Z3","Z4","Z5","Z6","Z8"],"default":"C62"},"itemPrice":{"title":"Item price","description":"The price per item (may be fractional)","type":"number","default":1.0},"baseQuantity":{"title":"Base Quantity","description":"The number of items the price is for.","type":"number","default":1.0},"amountExcludingTax":{"title":"amountExcludingTax","description":"The amount excluding tax. Should equal quantity x itemPrice + allowanceCharge.","type":"number"},"allowanceCharges":{"title":"Allowance Charges","description":"An array of allowance charges.","type":"array","items":{"$ref":"#/definitions/LineAllowanceCharge"},"minItems":0},"allowPartialDelivery":{"title":"Allow Partial Delivery","description":"Whether or not the line items must be delivered in a single shipment.","type":"boolean","default":false},"accountingCost":{"title":"Accounting Cost","description":"The buyer's accounting cost centre for this line.","type":"string","minLength":1},"delivery":{"title":"Delivery","description":"The delivery information for the line.","$ref":"#/definitions/LineDelivery"},"description":{"title":"Description","description":"The description for this line.","type":"string","minLength":1,"maxLength":255},"name":{"title":"Name","description":"A short name for this line.","type":"string","minLength":1,"maxLength":255},"references":{"title":"References","description":"An array of references to other documents or codes. Note that many syntaxes do not support multiple references of the same type in which case they will be concatenated with ','. Also, not all syntaxes support all documentTypes.","type":"array","items":{"$ref":"#/definitions/Reference"},"minItems":0},"taxesDutiesFees":{"title":"Taxes, Duties and Fees","description":"An array of taxes, duties and fees for this invoice line. Multiple taxesDutiesFees items is allowed only for IN (India) and US (USA) taxes. All other countries can only have a single Tax item in this array.","type":"array","items":{"$ref":"#/definitions/Tax"},"minItems":0},"additionalItemProperties":{"title":"Additional Item Properties","description":"An array of additional item properties.","type":"array","items":{"$ref":"#/definitions/AdditionalItemProperty"},"minItems":0},"lotNumberIds":{"title":"Lot Number Ids","description":"An identifier for the production lot which the line items come from.","type":"array","items":{"type":"string","maxLength":128},"minItems":0},"note":{"title":"Note","description":"A note to add to the line","type":"string","maxLength":255}},"required":["lineId","quantity","quantityUnitCode","amountExcludingTax"]},"Invoice":{"title":"Invoice","description":"The invoice to send. Provide either invoice, or invoiceData, but not both.","type":"object","properties":{"accountingCost":{"title":"Accounting Cost","description":"The buyer's accounting cost centre for this invoice, expressed as text.","type":"string","minLength":1},"accountingCurrencyExchangeRate":{"title":"Accounting Currency Exchange Rate","description":"Rate at which the document currency must be multiplied to convert it into the accounting currency. If included, must be non-zero.","type":"number"},"accountingCurrencyTaxableAmount":{"title":"Accounting Currency Taxable Amount","description":"The taxable amount in the accounting currency. If included, must be non-zero.","type":"number"},"accountingCurrencyTaxAmount":{"title":"Accounting Currency Tax Amount","description":"The total amount of tax in the accounting currency. If included, must be non-zero.","type":"number"},"accountingCurrencyTaxAmountCurrency":{"description":"The currency of the accountingCurrencyTaxAmount. This MUST be different from the documentCurrencyCode, since it makes no sense including this othterwise. Mandatory if accountingCurrencyTaxAmount is provided.","$ref":"#/definitions/CurrencyCode"},"accountingCustomerParty":{"description":"The party the invoice is sent to.","$ref":"#/definitions/AccountingCustomerParty"},"payeeParty":{"description":"The party to whom the invoice will be paid.","$ref":"#/definitions/PayeeParty"},"accountingSupplierParty":{"description":"The party sending the invoice. When you are sending, most data for the AccountingSupplierParty is taken from the LegalEntity in the Storecove database, where your sender identity resides and has been validated. However, we provide a limited number of fields (mainly contact fields) here that you can specify on a document-by-document basis. For receiving, the full party object can be received.","$ref":"#/definitions/AccountingSupplierParty"},"allowanceCharges":{"title":"Allowance Charges","description":"An array of allowance charges.","type":"array","items":{"$ref":"#/definitions/AllowanceCharge"},"minItems":0},"amountIncludingTax":{"title":"Amount including Tax","description":"EXPERIMENTAL for sending. The amountIncludingTax is the payable amount, but not corrected for the prepaid amount.","type":"number"},"amountIncludingVat":{"title":"Amount including VAT","description":"The amountIncludingVat is payable amount, but not corrected for the prepaid amount. We encourage you to use the amountIncludingTax for sending. For receiving, always use amountIncludingTax.","type":"number"},"attachments":{"title":"Attachments","description":"An array of attachments. You may provide up to 10 attchments, but the total size must not exceed 100MB after Base64 encoding.","type":"array","maxItems":10,"items":{"$ref":"#/definitions/Attachment"}},"consumerTaxMode":{"title":"Consumer Tax Mode","description":"Whether or not to process the invoice in consumer tax mode. In this mode, the VAT identifier of the sender will not be the default VAT identifier, but the one that matches with the country of the receiving consumer, if that additional VAT identifier for that country is available. These additional VAT identifiers need to be added to the sending LegalEntity by Storecove, so if you need to send invoices in this mode, please contact us. Not used for receiving.","type":"boolean","default":false},"delivery":{"title":"The Delivery","description":"The delivery of the invoice.","$ref":"#/definitions/Delivery"},"deliveryTerms":{"title":"Delivery Terms","description":"The terms of delivery for the document. This is currently only used for MY LHDNM.","$ref":"#/definitions/DeliveryTerms"},"documentCurrencyCode":{"description":"The documentCurrencyCode is the currency for the entire invoice. We currently do not support invoices in multiple currencies. If left out, will default to EUR","$ref":"#/definitions/CurrencyCode","default":"EUR"},"dueDate":{"title":"Due date","description":"Format: yyyy-mm-dd.","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},"invoiceLines":{"title":"Invoice lines","description":"An array of invoice lines.","type":"array","items":{"$ref":"#/definitions/InvoiceLine"},"minItems":1},"invoiceNumber":{"title":"Invoice number","description":"The invoice number you assigned to the invoice.","type":"string","minLength":1},"invoicePeriod":{"title":"Invoice period","description":"The period (or specific date) to which the invoice applies. Format: yyyy-mm-dd - yyyy-mm-dd.","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2} - [0-9]{4}-[0-9]{2}-[0-9]{2}$"},"issueDate":{"title":"Invoice issue date","description":"Format: yyyy-mm-dd.","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},"issueReasons":{"title":"Issue Reasons","description":"An array reasons for issuing the invoice.","type":"array","items":{"type":"string"}},"issueTime":{"title":"Document issue time","description":"Format: hh:mm:ss","type":"string","pattern":"^[0-9]{2}:[0-9]{2}:[0-9]{2}$"},"note":{"title":"Note","description":"A note to add to the invoice","type":"string"},"payableRoundingAmount":{"title":"Payable Rounding Amount","description":"The rounding amount for the payable amount. This amount is calulated automatically from the invoiceLines, allowanceCharges and the taxSubtotals. If you provide this field, it must be exactly what we would have calculated. We recommend not using this field for sending. For receiving, it is always present.","type":"number"},"paymentMeansArray":{"title":"Payment Means Array","description":"An array of payment means (ways to pay the invoice).","type":"array","items":{"$ref":"#/definitions/PaymentMeans"}},"paymentTerms":{"title":"Payment Terms","description":"The payment terms of the invoice.","$ref":"#/definitions/PaymentTerms"},"preferredInvoiceType":{"title":"Invoice Type","description":"In autodetect mode, the choice is made by Storecove based on what is appropriate for the receiver and the receiver country, in combination with the invoice amount sign. If you wish to state a preference, use this field. It is not guaranteed that the preference will be used, since it depends also on the receiver's document capabilities. Only used for sending, not for receiving. For Peppol, only invoice and creditnote are supported. For LHDNM, also debitnote and refundnote are supported. Anything starting it_td* can only be used for SDI. Only used for sending, not present for receiving.","type":"string","enum":["prefer_autodetect","prefer_invoice","prefer_creditnote","prefer_debitnote","prefer_refundnote","prefer_corrected_invoice","prefer_it_td02","prefer_it_td19","prefer_it_td24"],"default":"prefer_autodetect"},"prepaidAmount":{"title":"Prepaid Amount","description":"The amount already paid. The amountInclucingTax - prepaidAmount is the amount remaining to be paid. Use either this field or the prepaidPayments field, but not both.","type":"number"},"prepaidPayments":{"title":"Prepaid Payments","description":"An array of prepaid payments. Currently can be used only for Malaysia. Even though this is an array, it is currently expected to contain only one item. Use either this field or the prepaidAmount field, but not both.","type":"array","items":{"$ref":"#/definitions/PrepaidPayment"}},"priceMode":{"title":"Price Mode","description":"The price mode. This is used to determine whether the prices are net or gross. Price Mode 'price_mode_gross' can only be used for sender countries ES, IT and PT, \"clearWithoutSending\": true and \"taxSystem\": \"tax_line_percentages\". Only used for sending, not present for receiving.","type":"string","enum":["price_mode_net","price_mode_gross"],"default":"price_mode_net"},"references":{"title":"References","description":"An array of references to other documents. Note that many syntaxes do not support multiple references of the same type in which case they will be concatenated with ','. Also, not all syntaxes support all documentTypes.","type":"array","items":{"$ref":"#/definitions/Reference"},"minItems":0},"selfBillingMode":{"title":"Self Billing Mode","description":"+++\n<p>        There are two reasons for using self billing mode:</p><ol>        <li>                The buyer generated the invoice and it needs to be sent to the seller. When sending via Peppol, the receiver needs to support this by advertising a special \"self-billing\" document type. Otherwise, an email will be sent.        </li>        <li>                An invoice was received that needs to be reported as a purchase invoice to a tax authority.        </li></ol><p>        When sending in this mode the buyer (\"AccountingCustomerParty\") and the seller (\"AccountingSupplierParty\") are automatically switched. That means you still provide the same legalEntityId for the sender (who is now the buyer) and the accountingCustomerParty object is still the receiver (but it is now the seller). That means no changes to the JSON are necessary.</p><p>        When reporting a received invoice to a tax authority, set the \"clearWithoutSending\": true flag. Otherwise, the invoice will be reported _and_ sent back to the sender!</p><p>        This field is only used for sending. We currently do not set this for receiving although that is on the roadmap.</p>\n+++","type":"boolean","default":false},"subType":{"title":"Sub Type","description":"The document subtype. Only used for received invoices, not for sending.","type":"string","enum":["invoice","creditnote","debitnote","correctioninvoice"]},"taxPointDate":{"title":"Tax date","description":"The tax date is the date on which the supply of goods or of services was made or completed or the date on which the payment on account was made insofar as that date can be determined and differs from the date of the issue of the invoice. EU 2006-112 Article 226 Point 7. Note: For the Dutch TAX authorities the tac date should be the same as the issue date.","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},"taxSubtotals":{"title":"Tax Subtotals","description":"An array of tax subtotals. This element is mandatory for taxSystem 'tax_line_percentages'.","type":"array","items":{"$ref":"#/definitions/TaxSubtotal"},"minItems":0},"taxSystem":{"title":"Tax System","description":"The tax system used for the invoice. The system 'tax_line_percentages' is preferred, but for historic purposes 'tax_line_amounts' is supported and the default. Since not all invoice formats that we are required to send support 'tax_line_amounts' we will need to convert the invoice to the 'tax_line_percentags' system if we are forced to send the invoice in that tax system. Note that an invoice must always contain tax information, even if that is 0% or an item or sender is exempt or tax is completely outside scope. In that case, use the correct tax categories (see <<_openapi_tax>>)","type":"string","enum":["tax_line_amounts","tax_line_percentages"],"default":"tax_line_amounts"},"taxesDutiesFees":{"title":"Taxes, Duties and Fees","description":"An array of taxes, duties and fees for this invoice. At this moment, the only invoice level tax allowed is the Italian '€2 bollo virtuale'","type":"array","items":{"$ref":"#/definitions/Tax"},"minItems":0,"maxItems":1},"timeZone":{"title":"Document issue timezone","description":"Format: ±zzzz, where ±zzzz is the difference from UTC, e.g. +0100 or -0900 etc. The timezone will also apply to the document issue date if this field is provided.","type":"string","pattern":"^[+-]\\d{4}$"},"transactionType":{"title":"Transaction Type","description":"The type of transaction. Currently used only for India.","type":"string","enum":["b2b","sezwp","sezwop","expwp","expwop","dexp"]},"taxAuthority":{"description":"Information relating to a tax authority.","$ref":"#/definitions/TaxAuthority"},"ublExtensions":{"title":"UBL Extensions","description":"An array of ubl extensions.","type":"array","items":{"type":"string"}},"x2y":{"title":"x2y","description":"The type of entities the document is sent from/to: b2b (business-to-business), b2g (business-to-government) or b2c (business-to-consumer). This field does not have a default, but it in mose cases it will be treated as b2b. Only when you explicitly specify b2g or b2c OR when it is clear from the context will a different value be used. For instance, when we see the document is being routed to DE:LWID or NL:OINO number, this tells us it is b2g. But in many cases we are unable to determine this and so it is best to always specify this field. Note that b2b_sez is for use inside India only. This field is for sending only. Note that b2c_petty_cash (deprecated: petty_cash) is for use in Singapore only and is for reporting petty cash transactions in selfBillingMode. Also note that the categories b2c_point_of_sale and b2c_simplified_tax_invoice are for use in Singapore only and are for reporting point of sale transactions and simplified tax invoices respectively.","type":"string","enum":["b2b","b2g","b2c","b2b_sez","petty_cash","b2c_point_of_sale","b2c_simplified_tax_invoice","b2c_petty_cash"],"default":"b2b"},"vatReverseCharge":{"description":"DEPRECATED. Use taxExemptReason.","type":"boolean","default":false},"taxExemptReason":{"description":"DEPRECATED. Use Tax/category and specify this per invoice line. If you do specify this field, it will be applied to all invoice lines and it is an error to specify a Tax/category at the invoice line level. This field holds the reason no tax is present in the invoice. Note that this is an invoice level field and you cannot specify it per invoice line. This field is mandatory unless tax is present in the invoice.","type":"string","enum":["export","reverse_charge","zero_rated","exempt","outside_scope","intra_community"]},"invoiceType":{"title":"Type of invoice","description":"DEPRECATED. Do not use. This field is available for legacy reasons only. If you want to send a regular invoice (aka UBL type '380'), make sure you have a positive invoice amount. For a credit note (aka UBL type '381'), simply provide a negative invoice amount. If you, in addition to a negative invoice amount, also specify a billingReferences, your invoice will become a corrective invoice (aka UBL type '384'). If your invoice is not sent in the UBL syntax, Storecove will provide the appropriate type for the syntax the invoice is sent in.","type":"string","enum":["380","383","381","384","261","527","389"],"default":"380"},"buyerReference":{"title":"Buyer reference","description":"DEPRECATED. Use a reference object with a documentType 'buyer_reference'. A reference provided by the buyer used for internal routing of the document.","type":"string"},"orderReference":{"title":"Order reference","description":"DEPRECATED. Use a reference object with a documentType 'purchase_order'. A reference to an order for this invoice, assigned by the buyer. Note that this often is a key field, since many receivers of invoices will use this field to automatically match the invoice to an order they placed. Many receivers refuse invoices that cannot be automatically matched, in particular government agencies. So it is highly recommended to fill this field whenever possible.","type":"string"},"salesOrderId":{"title":"Sales Order Id","description":"DEPRECATED. Use a reference object with a documentType 'sales_order'. A reference to an order for this invoice, assigned by the seller.","type":"string"},"billingReference":{"title":"Billing reference","description":"DEPRECATED. Use a reference object with a documentType 'billing'. A reference to a commercial invoice or corrective invoice of which the current invoice is a correction. This field is mandatory when sending invoiceType 384.","type":"string"},"contractDocumentReference":{"title":"Contract document reference","description":"DEPRECATED. Use a reference object with a documentType 'contract'. A reference to a contract or framework agreement that this invoice relates to.","type":"string"},"projectReference":{"title":"Project Reference","description":"DEPRECATED. Information about the project this invoice relates to.","type":"string"},"paymentMeansIban":{"title":"IBAN","description":"DEPRECATED. Use paymentMeansArray. The IBAN the amount payable should be transferred to","type":"string"},"paymentMeansBic":{"title":"BIC","description":"DEPRECATED. Use paymentMeansArray. The BIC (Swift) of the bank where the amount payable should be transferred to","type":"string","pattern":"^[A-Z]{6}[2-9A-Z][0-9A-NP-Z]([A-Z0-9]{3}|X{3})?$"},"paymentMeansCode":{"title":"Payment Means Code","description":"DEPRECATED. Use paymentMeansArray. How the invoice has been / will be paid. Use only online_payment_service (payment will be made or has been made by an online payment service), bank_card (e.g. debit card, credit card), direct_debit (the amount has been / will be taken out of the client's bank account), standing_agreement (an unspecified payment means known to both buyer and seller) or credit_transfer (the buyer will do / has done a bank transfer). The numeric codes are for legacy purposes, they should not be used.","type":"string","enum":["online_payment_service","bank_card","direct_debit","standing_agreement","credit_transfer","se_bankgiro","se_plusgiro","aunz_npp","","1","30","31","42","48","49","57","58"]},"paymentMeansPaymentId":{"title":"Payment Id","description":"DEPRECATED. Use the paymentId in the individual PaymentMeans object. The payment id that you will use to match the payment against the invoice.","type":"string"}},"required":["invoiceNumber","issueDate","accountingCustomerParty","invoiceLines"]},"InvoiceLine":{"title":"Invoice line","type":"object","properties":{"lineId":{"title":"Invoice Line ID","description":"The id for this invoice line.","type":"string","minLength":1,"maxLength":36},"description":{"title":"Description","description":"The description for this invoice line.","type":"string","minLength":1},"name":{"title":"Name","description":"A short name for this invoice line. If not provided, it will be taken from description and description will be set to an emtpy string.","type":"string","minLength":1},"orderLineReferenceLineId":{"title":"orderLineReferenceLineId","description":"DEPRECATED. Use a reference with type 'line_purchase_order'. A reference to the LineID of the order. The order itself is specified as the orderReference at the invoice level. It is not possible to specify an orderReference at the invoice line level. An invoice MUST at this time be for a single order only.","type":"string","minLength":1},"invoicePeriod":{"title":"Invoice period","description":"The period (or specific date) to which the invoice line applies. Format: yyyy-mm-dd - yyyy-mm-dd.","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2} - [0-9]{4}-[0-9]{2}-[0-9]{2}$"},"itemPrice":{"title":"Item price","description":"DEPRECATED - use the price object. The price per item (may be fractional)","type":"number","default":1.0},"quantity":{"title":"Quantity","description":"The number of items (may be fractional).","type":"number","default":1.0},"baseQuantity":{"title":"Base Quantity","description":"DEPRECATED - use the price object. The number of items (may be fractional) the itemPrice is for.","type":"number","default":1.0},"price":{"title":"Price","description":"The price details for the invoice line.","type":"object","properties":{"priceAmount":{"title":"Price Amount","description":"The price per item (may be fractional).","type":"number"},"baseQuantity":{"title":"Base Quantity","description":"The number of items (may be fractional) the priceAmount is for.","type":"number","default":1.0},"allowanceCharges":{"title":"Price Allowance Charges","description":"An array of allowances and charges that apply to the item price. Only a single item is currently supported, and reason fields are not allowed.","type":"array","items":{"allOf":[{"$ref":"#/definitions/LineAllowanceCharge"}],"not":{"anyOf":[{"required":["reason"]},{"required":["reasonCode"]}]}},"minItems":0,"maxItems":1}}},"quantityUnitCode":{"title":"Quantity Unit Code","description":"The unit of measure that applies to the invoiced quantity. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the \"Intro\" section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. To avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure. Note that the following additionally allowed codes are deprecated and will be converted to C62: 04, 05, 08, 16, 17, 18, 19, 26, 29, 30, 31, 32, 36, 43, 44, 45, 46, 47, 48, 53, 54, 62, 63, 64, 66, 69, 71, 72, 73, 76, 78, 84, 90, 92, 93, 94, 95, 96, 97, 98, 1A, 1B, 1C, 1D, 1E, 1F, 1G, 1H, 1J, 1K, 1L, 1M, 1X, 2V, 2W, 3E, 3G, 3H, 3I, 4A, 4B, 4E, 5C, 5F, 5G, 5H, 5I, 5K, 5P, 5Q, A1, A25, A50, A51, A52, A57, A58, A60, A61, A62, A63, A64, A65, A66, A67, A77, A78, A79, A80, A81, A82, A83, AJ, AM, AP, AR, ARE, ATT, AV, AW, B0, B2, B36, B37, B38, B39, B40, B5, B51, B6, B65, B9, BD, BE, BG, BH, BJ, BK, BL, BO, BR, BT, BW, BX, BZ, C1, C2, C4, C5, C6, C77, C98, CA, CH, CJ, CK, CL, CO, CQ, CR, CS, CT, CU, CV, CY, CZ, D14, D28, D35, D37, D38, D39, D40, D64, D66, D67, D7, D70, D71, D72, D75, D76, D79, D8, D9, D90, D92, D96, D97, D98, D99, DC, DE, DI, DQ, DR, DRM, DS, DU, DX, DY, E2, E3, E5, EC, EP, EV, F1, F9, FB, FD, FE, FG, FM, G7, GC, GD, GH, GK, GN, GRT, GT, GW, GY, GZ, H1, H2, HAR, HD, HE, HF, HI, HJ, HK, HL, HN, HO, HP, HS, HT, HY, IC, IF, II, IL, IM, IP, IT, JB, JG, JO, JR, K5, KD, KF, KG, KS, KTM, LC, LE, LI, LJ, LX, M0, MA, MF, MK, MQ, MT, MV, N2, NB, NBB, NC, ND, NE, NG, NH, NI, NJ, NN, NPL, NPR, NQ, NR, NRL, NTT, NV, NY, OP, OZ, P0, P3, P4, P6, P7, P8, P9, PA, PB, PE, PF, PG, PK, PL, PM, PN, PT, PU, PV, PW, PY, PZ, QD, QH, QK, QT, R4, RA, RD, RG, RK, RL, RN, RO, RS, RU, S5, S6, S7, S8, SA, SD, SE, SHT, SK, SL, SN, SO, SP, SS, SST, ST, SV, T1, T4, T5, T6, T7, T8, TA, TC, TD, TE, TF, TJ, TK, TL, TN, TQ, TR, TS, TSD, TSH, TT, TU, TV, TW, TY, UA, UD, UE, UF, UH, UM, VI, VQ, VS, W4, WH, WI, WR, WW, YL, YT, Z1, Z2, Z3, Z4, Z5, Z6, Z8. Also, LOT can only be used for SG-IRAS invoices.","type":"string","enum":["LOT","10","11","13","14","15","20","21","22","23","24","25","27","28","33","34","35","37","38","40","41","56","57","58","59","60","61","74","77","80","81","85","87","89","91","1I","2A","2B","2C","2G","2H","2I","2J","2K","2L","2M","2N","2P","2Q","2R","2U","2X","2Y","2Z","3B","3C","4C","4G","4H","4K","4L","4M","4N","4O","4P","4Q","4R","4T","4U","4W","4X","5A","5B","5E","5J","A10","A11","A12","A13","A14","A15","A16","A17","A18","A19","A2","A20","A21","A22","A23","A24","A26","A27","A28","A29","A3","A30","A31","A32","A33","A34","A35","A36","A37","A38","A39","A4","A40","A41","A42","A43","A44","A45","A47","A48","A49","A5","A53","A54","A55","A56","A59","A6","A68","A69","A7","A70","A71","A73","A74","A75","A76","A8","A84","A85","A86","A87","A88","A89","A9","A90","A91","A93","A94","A95","A96","A97","A98","A99","AA","AB","ACR","ACT","AD","AE","AH","AI","AK","AL","AMH","AMP","ANN","APZ","AQ","AS","ASM","ASU","ATM","AWG","AY","AZ","B1","B10","B11","B12","B13","B14","B15","B16","B17","B18","B19","B20","B21","B22","B23","B24","B25","B26","B27","B28","B29","B3","B30","B31","B32","B33","B34","B35","B4","B41","B42","B43","B44","B45","B46","B47","B48","B49","B50","B52","B53","B54","B55","B56","B57","B58","B59","B60","B61","B62","B63","B64","B66","B67","B68","B69","B7","B70","B71","B72","B73","B74","B75","B76","B77","B78","B79","B8","B80","B81","B82","B83","B84","B85","B86","B87","B88","B89","B90","B91","B92","B93","B94","B95","B96","B97","B98","B99","BAR","BB","BFT","BHP","BIL","BLD","BLL","BP","BPM","BQL","BTU","BUA","BUI","C0","C10","C11","C12","C13","C14","C15","C16","C17","C18","C19","C20","C21","C22","C23","C24","C25","C26","C27","C28","C29","C3","C30","C31","C32","C33","C34","C35","C36","C37","C38","C39","C40","C41","C42","C43","C44","C45","C46","C47","C48","C49","C50","C51","C52","C53","C54","C55","C56","C57","C58","C59","C60","C61","C62","C63","C64","C65","C66","C67","C68","C69","C7","C70","C71","C72","C73","C74","C75","C76","C78","C79","C8","C80","C81","C82","C83","C84","C85","C86","C87","C88","C89","C9","C90","C91","C92","C93","C94","C95","C96","C97","C99","CCT","CDL","CEL","CEN","CG","CGM","CKG","CLF","CLT","CMK","CMQ","CMT","CNP","CNT","COU","CTG","CTM","CTN","CUR","CWA","CWI","D03","D04","D1","D10","D11","D12","D13","D15","D16","D17","D18","D19","D2","D20","D21","D22","D23","D24","D25","D26","D27","D29","D30","D31","D32","D33","D34","D36","D41","D42","D43","D44","D45","D46","D47","D48","D49","D5","D50","D51","D52","D53","D54","D55","D56","D57","D58","D59","D6","D60","D61","D62","D63","D65","D68","D69","D73","D74","D77","D78","D80","D81","D82","D83","D85","D86","D87","D88","D89","D91","D93","D94","D95","DAA","DAD","DAY","DB","DD","DEC","DG","DJ","DLT","DMA","DMK","DMO","DMQ","DMT","DN","DPC","DPR","DPT","DRA","DRI","DRL","DT","DTN","DWT","DZN","DZP","E01","E07","E08","E09","E10","E12","E14","E15","E16","E17","E18","E19","E20","E21","E22","E23","E25","E27","E28","E30","E31","E32","E33","E34","E35","E36","E37","E38","E39","E4","E40","E41","E42","E43","E44","E45","E46","E47","E48","E49","E50","E51","E52","E53","E54","E55","E56","E57","E58","E59","E60","E61","E62","E63","E64","E65","E66","E67","E68","E69","E70","E71","E72","E73","E74","E75","E76","E77","E78","E79","E80","E81","E82","E83","E84","E85","E86","E87","E88","E89","E90","E91","E92","E93","E94","E95","E96","E97","E98","E99","EA","EB","EQ","F01","F02","F03","F04","F05","F06","F07","F08","F10","F11","F12","F13","F14","F15","F16","F17","F18","F19","F20","F21","F22","F23","F24","F25","F26","F27","F28","F29","F30","F31","F32","F33","F34","F35","F36","F37","F38","F39","F40","F41","F42","F43","F44","F45","F46","F47","F48","F49","F50","F51","F52","F53","F54","F55","F56","F57","F58","F59","F60","F61","F62","F63","F64","F65","F66","F67","F68","F69","F70","F71","F72","F73","F74","F75","F76","F77","F78","F79","F80","F81","F82","F83","F84","F85","F86","F87","F88","F89","F90","F91","F92","F93","F94","F95","F96","F97","F98","F99","FAH","FAR","FBM","FC","FF","FH","FIT","FL","FOT","FP","FR","FS","FTK","FTQ","G01","G04","G05","G06","G08","G09","G10","G11","G12","G13","G14","G15","G16","G17","G18","G19","G2","G20","G21","G23","G24","G25","G26","G27","G28","G29","G3","G30","G31","G32","G33","G34","G35","G36","G37","G38","G39","G40","G41","G42","G43","G44","G45","G46","G47","G48","G49","G50","G51","G52","G53","G54","G55","G56","G57","G58","G59","G60","G61","G62","G63","G64","G65","G66","G67","G68","G69","G70","G71","G72","G73","G74","G75","G76","G77","G78","G79","G80","G81","G82","G83","G84","G85","G86","G87","G88","G89","G90","G91","G92","G93","G94","G95","G96","G97","G98","G99","GB","GBQ","GDW","GE","GF","GFI","GGR","GIA","GIC","GII","GIP","GJ","GL","GLD","GLI","GLL","GM","GO","GP","GQ","GRM","GRN","GRO","GV","GWH","H03","H04","H05","H06","H07","H08","H09","H10","H11","H12","H13","H14","H15","H16","H18","H19","H20","H21","H22","H23","H24","H25","H26","H27","H28","H29","H30","H31","H32","H33","H34","H35","H36","H37","H38","H39","H40","H41","H42","H43","H44","H45","H46","H47","H48","H49","H50","H51","H52","H53","H54","H55","H56","H57","H58","H59","H60","H61","H62","H63","H64","H65","H66","H67","H68","H69","H70","H71","H72","H73","H74","H75","H76","H77","H79","H80","H81","H82","H83","H84","H85","H87","H88","H89","H90","H91","H92","H93","H94","H95","H96","H98","H99","HA","HBA","HBX","HC","HDW","HEA","HGM","HH","HIU","HKM","HLT","HM","HMQ","HMT","HPA","HTZ","HUR","IA","IE","INH","INK","INQ","ISD","IU","IV","J10","J12","J13","J14","J15","J16","J17","J18","J19","J2","J20","J21","J22","J23","J24","J25","J26","J27","J28","J29","J30","J31","J32","J33","J34","J35","J36","J38","J39","J40","J41","J42","J43","J44","J45","J46","J47","J48","J49","J50","J51","J52","J53","J54","J55","J56","J57","J58","J59","J60","J61","J62","J63","J64","J65","J66","J67","J68","J69","J70","J71","J72","J73","J74","J75","J76","J78","J79","J81","J82","J83","J84","J85","J87","J90","J91","J92","J93","J95","J96","J97","J98","J99","JE","JK","JM","JNT","JOU","JPS","JWL","K1","K10","K11","K12","K13","K14","K15","K16","K17","K18","K19","K2","K20","K21","K22","K23","K26","K27","K28","K3","K30","K31","K32","K33","K34","K35","K36","K37","K38","K39","K40","K41","K42","K43","K45","K46","K47","K48","K49","K50","K51","K52","K53","K54","K55","K58","K59","K6","K60","K61","K62","K63","K64","K65","K66","K67","K68","K69","K70","K71","K73","K74","K75","K76","K77","K78","K79","K80","K81","K82","K83","K84","K85","K86","K87","K88","K89","K90","K91","K92","K93","K94","K95","K96","K97","K98","K99","KA","KAT","KB","KBA","KCC","KDW","KEL","KGM","KGS","KHY","KHZ","KI","KIC","KIP","KJ","KJO","KL","KLK","KLX","KMA","KMH","KMK","KMQ","KMT","KNI","KNM","KNS","KNT","KO","KPA","KPH","KPO","KPP","KR","KSD","KSH","KT","KTN","KUR","KVA","KVR","KVT","KW","KWH","KWO","KWT","KX","L10","L11","L12","L13","L14","L15","L16","L17","L18","L19","L2","L20","L21","L23","L24","L25","L26","L27","L28","L29","L30","L31","L32","L33","L34","L35","L36","L37","L38","L39","L40","L41","L42","L43","L44","L45","L46","L47","L48","L49","L50","L51","L52","L53","L54","L55","L56","L57","L58","L59","L60","L63","L64","L65","L66","L67","L68","L69","L70","L71","L72","L73","L74","L75","L76","L77","L78","L79","L80","L81","L82","L83","L84","L85","L86","L87","L88","L89","L90","L91","L92","L93","L94","L95","L96","L98","L99","LA","LAC","LBR","LBT","LD","LEF","LF","LH","LK","LM","LN","LO","LP","LPA","LR","LS","LTN","LTR","LUB","LUM","LUX","LY","M1","M10","M11","M12","M13","M14","M15","M16","M17","M18","M19","M20","M21","M22","M23","M24","M25","M26","M27","M29","M30","M31","M32","M33","M34","M35","M36","M37","M38","M39","M4","M40","M41","M42","M43","M44","M45","M46","M47","M48","M49","M5","M50","M51","M52","M53","M55","M56","M57","M58","M59","M60","M61","M62","M63","M64","M65","M66","M67","M68","M69","M7","M70","M71","M72","M73","M74","M75","M76","M77","M78","M79","M80","M81","M82","M83","M84","M85","M86","M87","M88","M89","M9","M90","M91","M92","M93","M94","M95","M96","M97","M98","M99","MAH","MAL","MAM","MAR","MAW","MBE","MBF","MBR","MC","MCU","MD","MGM","MHZ","MIK","MIL","MIN","MIO","MIU","MLD","MLT","MMK","MMQ","MMT","MND","MON","MPA","MQH","MQS","MSK","MTK","MTQ","MTR","MTS","MVA","MWH","N1","N10","N11","N12","N13","N14","N15","N16","N17","N18","N19","N20","N21","N22","N23","N24","N25","N26","N27","N28","N29","N3","N30","N31","N32","N33","N34","N35","N36","N37","N38","N39","N40","N41","N42","N43","N44","N45","N46","N47","N48","N49","N50","N51","N52","N53","N54","N55","N56","N57","N58","N59","N60","N61","N62","N63","N64","N65","N66","N67","N68","N69","N70","N71","N72","N73","N74","N75","N76","N77","N78","N79","N80","N81","N82","N83","N84","N85","N86","N87","N88","N89","N90","N91","N92","N93","N94","N95","N96","N97","N98","N99","NA","NAR","NCL","NEW","NF","NIL","NIU","NL","NM3","NMI","NMP","NPT","NT","NU","NX","OA","ODE","OHM","ON","ONZ","OPM","OT","OZA","OZI","P1","P10","P11","P12","P13","P14","P15","P16","P17","P18","P19","P2","P20","P21","P22","P23","P24","P25","P26","P27","P28","P29","P30","P31","P32","P33","P34","P35","P36","P37","P38","P39","P40","P41","P42","P43","P44","P45","P46","P47","P48","P49","P5","P50","P51","P52","P53","P54","P55","P56","P57","P58","P59","P60","P61","P62","P63","P64","P65","P66","P67","P68","P69","P70","P71","P72","P73","P74","P75","P76","P77","P78","P79","P80","P81","P82","P83","P84","P85","P86","P87","P88","P89","P90","P91","P92","P93","P94","P95","P96","P97","P98","P99","PAL","PD","PFL","PGL","PI","PLA","PO","PQ","PR","PS","PTD","PTI","PTL","PTN","Q10","Q11","Q12","Q13","Q14","Q15","Q16","Q17","Q18","Q19","Q20","Q21","Q22","Q23","Q24","Q25","Q26","Q27","Q28","Q29","Q30","Q31","Q32","Q33","Q34","Q35","Q36","Q37","Q38","Q39","Q40","Q3","QA","QAN","QB","QR","QTD","QTI","QTL","QTR","R1","R9","RH","RM","ROM","RP","RPM","RPS","RT","S3","S4","SAN","SCO","SCR","SEC","SET","SG","SIE","SM3","SMI","SQ","SQR","SR","STC","STI","STK","STL","STN","STW","SW","SX","SYR","T0","T3","TAH","TAN","TI","TIC","TIP","TKM","TMS","TNE","TP","TPI","TPR","TQD","TRL","TST","TTS","U1","U2","UB","UC","VA","VLT","VP","W2","WA","WB","WCD","WE","WEB","WEE","WG","WHR","WM","WSD","WTT","X1","YDK","YDQ","YRD","Z11","ZP","ZZ","X1A","X1B","X1D","X1F","X1G","X1W","X2C","X3A","X3H","X43","X44","X4A","X4B","X4C","X4D","X4F","X4G","X4H","X5H","X5L","X5M","X6H","X6P","X7A","X7B","X8A","X8B","X8C","XAA","XAB","XAC","XAD","XAE","XAF","XAG","XAH","XAI","XAJ","XAL","XAM","XAP","XAT","XAV","XB4","XBA","XBB","XBC","XBD","XBE","XBF","XBG","XBH","XBI","XBJ","XBK","XBL","XBM","XBN","XBO","XBP","XBQ","XBR","XBS","XBT","XBU","XBV","XBW","XBX","XBY","XBZ","XCA","XCB","XCC","XCD","XCE","XCF","XCG","XCH","XCI","XCJ","XCK","XCL","XCM","XCN","XCO","XCP","XCQ","XCR","XCS","XCT","XCU","XCV","XCW","XCX","XCY","XCZ","XDA","XDB","XDC","XDG","XDH","XDI","XDJ","XDK","XDL","XDM","XDN","XDP","XDR","XDS","XDT","XDU","XDV","XDW","XDX","XDY","XEC","XED","XEE","XEF","XEG","XEH","XEI","XEN","XFB","XFC","XFD","XFE","XFI","XFL","XFO","XFP","XFR","XFT","XFW","XFX","XGB","XGI","XGL","XGR","XGU","XGY","XGZ","XHA","XHB","XHC","XHG","XHN","XHR","XIA","XIB","XIC","XID","XIE","XIF","XIG","XIH","XIK","XIL","XIN","XIZ","XJB","XJC","XJG","XJR","XJT","XJY","XKG","XKI","XLE","XLG","XLT","XLU","XLV","XLZ","XMA","XMB","XMC","XME","XMR","XMS","XMT","XMW","XMX","XNA","XNE","XNF","XNG","XNS","XNT","XNU","XNV","XOA","XOB","XOC","XOD","XOE","XOF","XOK","XOT","XOU","XP2","XPA","XPB","XPC","XPD","XPE","XPF","XPG","XPH","XPI","XPJ","XPK","XPL","XPN","XPO","XPP","XPR","XPT","XPU","XPV","XPX","XPY","XPZ","XQA","XQB","XQC","XQD","XQF","XQG","XQH","XQJ","XQK","XQL","XQM","XQN","XQP","XQQ","XQR","XQS","XRD","XRG","XRJ","XRK","XRL","XRO","XRT","XRZ","XSA","XSB","XSC","XSD","XSE","XSH","XSI","XSK","XSL","XSM","XSO","XSP","XSS","XST","XSU","XSV","XSW","XSX","XSY","XSZ","XT1","XTB","XTC","XTD","XTE","XTG","XTI","XTK","XTL","XTN","XTO","XTR","XTS","XTT","XTU","XTV","XTW","XTY","XTZ","XUC","XUN","XVA","XVG","XVI","XVK","XVL","XVO","XVP","XVQ","XVN","XVR","XVS","XVY","XWA","XWB","XWC","XWD","XWF","XWG","XWH","XWJ","XWK","XWL","XWM","XWN","XWP","XWQ","XWR","XWS","XWT","XWU","XWV","XWW","XWX","XWY","XWZ","XXA","XXB","XXC","XXD","XXF","XXG","XXH","XXJ","XXK","XYA","XYB","XYC","XYD","XYF","XYG","XYH","XYJ","XYK","XYL","XYM","XYN","XYP","XYQ","XYR","XYS","XYT","XYV","XYW","XYX","XYY","XYZ","XZA","XZB","XZC","XZD","XZF","XZG","XZH","XZJ","XZK","XZL","XZM","XZN","XZP","XZQ","XZR","XZS","XZT","XZU","XZV","XZW","XZX","XZY","XZZ","04","05","08","16","17","18","19","26","29","30","31","32","36","43","44","45","46","47","48","53","54","62","63","64","66","69","71","72","73","76","78","84","90","92","93","94","95","96","97","98","1A","1B","1C","1D","1E","1F","1G","1H","1J","1K","1L","1M","1X","2V","2W","3E","3G","3H","3I","4A","4B","4E","5C","5F","5G","5H","5I","5K","5P","5Q","A1","A25","A50","A51","A52","A57","A58","A60","A61","A62","A63","A64","A65","A66","A67","A77","A78","A79","A80","A81","A82","A83","AJ","AM","AP","AR","ARE","ATT","AV","AW","B0","B2","B36","B37","B38","B39","B40","B5","B51","B6","B65","B9","BD","BE","BG","BH","BJ","BK","BL","BO","BR","BT","BW","BX","BZ","C1","C2","C4","C5","C6","C77","C98","CA","CH","CJ","CK","CL","CO","CQ","CR","CS","CT","CU","CV","CY","CZ","D14","D28","D35","D37","D38","D39","D40","D64","D66","D67","D7","D70","D71","D72","D75","D76","D79","D8","D9","D90","D92","D96","D97","D98","D99","DC","DE","DI","DQ","DR","DRM","DS","DU","DX","DY","E2","E3","E5","EC","EP","EV","F1","F9","FB","FD","FE","FG","FM","G7","GC","GD","GH","GK","GN","GRT","GT","GW","GY","GZ","H1","H2","HAR","HD","HE","HF","HI","HJ","HK","HL","HN","HO","HP","HS","HT","HY","IC","IF","II","IL","IM","IP","IT","JB","JG","JO","JR","K5","KD","KF","KG","KS","KTM","LC","LE","LI","LJ","LX","M0","MA","MF","MK","MQ","MT","MV","N2","NB","NBB","NC","ND","NE","NG","NH","NI","NJ","NN","NPL","NPR","NQ","NR","NRL","NTT","NV","NY","OP","OZ","P0","P3","P4","P6","P7","P8","P9","PA","PB","PE","PF","PG","PK","PL","PM","PN","PT","PU","PV","PW","PY","PZ","QD","QH","QK","QT","R4","RA","RD","RG","RK","RL","RN","RO","RS","RU","S5","S6","S7","S8","SA","SD","SE","SHT","SK","SL","SN","SO","SP","SS","SST","ST","SV","T1","T4","T5","T6","T7","T8","TA","TC","TD","TE","TF","TJ","TK","TL","TN","TQ","TR","TS","TSD","TSH","TT","TU","TV","TW","TY","UA","UD","UE","UF","UH","UM","VI","VQ","VS","W4","WH","WI","WR","WW","YL","YT","Z1","Z2","Z3","Z4","Z5","Z6","Z8"],"default":"C62"},"allowanceCharge":{"title":"allowanceCharge","description":"DEPRECATED. Use allowanceCharges. The discount or surcharge on this item. Should be negative for discounts","type":"number"},"allowanceCharges":{"title":"Allowance Charges","description":"An array of allowances and charges.","type":"array","items":{"$ref":"#/definitions/LineAllowanceCharge"},"minItems":0},"amountExcludingVat":{"title":"amountExcludingVat","description":"The amount excluding tax. Should equal quantity x itemPrice + allowanceCharge.","type":"number"},"amountExcludingTax":{"title":"amountExcludingTax","description":"The amount excluding tax. EXPERIMENTAL for sending. Should equal quantity x itemPrice + allowanceCharge.","type":"number"},"amountIncludingTax":{"title":"amountIncludingTax","description":"The amount including tax. Can only be used for \"priceMode\": \"price_mode_gross\". Use either this property or amountExcludingTax (amountExcludingVat).","type":"number"},"tax":{"title":"Tax","description":"DEPRECATED. Use taxesDutiesFees. The tax for this invoice line.","$ref":"#/definitions/Tax"},"taxesDutiesFees":{"title":"Taxes, Duties and Fees","description":"An array of taxes, duties and fees for this invoice line. Multiple taxesDutiesFees items is allowed only for IN (India) and US (USA) taxes. All other countries can only have a single Tax item in this array.","type":"array","items":{"$ref":"#/definitions/Tax"},"minItems":0},"accountingCost":{"title":"Accounting Cost","description":"The buyer's accounting cost centre for this invoice line, expressed as text.","type":"string","minLength":1},"references":{"title":"References","description":"An array of references to other documents or codes. Note that many syntaxes do not support multiple references of the same type in which case they will be concatenated with ','. Also, not all syntaxes support all documentTypes.","type":"array","items":{"$ref":"#/definitions/Reference"},"minItems":0},"additionalItemProperties":{"title":"Additional Item Properties","description":"An array of additional item properties.","type":"array","items":{"$ref":"#/definitions/AdditionalItemProperty"},"minItems":0},"sellersItemIdentification":{"title":"Sellers Item Identification","description":"DEPRECATED. Use the references array with 'line_sellers_item_identification' documentType. The ID the seller assigned to this item.","type":"string","minLength":1},"buyersItemIdentification":{"title":"Buyers Item Identification","description":"DEPRECATED. Use the references array with 'line_buyers_item_identification' documentType. The ID the buyer assigned to this item.","type":"string","minLength":1},"standardItemIdentification":{"title":"Standard Item Identification","description":"DEPRECATED. Use 'line_standard_item_identification'. Standardized ID for the item.","type":"string","minLength":1},"standardItemIdentificationSchemeId":{"title":"Standard Item Identification Scheme","description":"DEPRECATED. Use the references array with 'line_standard_item_identification' documentType. The scheme for the standardized ID for the item.","type":"string","minLength":1,"default":"GTIN"},"standardItemIdentificationSchemeAgencyId":{"title":"Standard Item Identification Scheme Agency","description":"DEPRECATED. Use the references array with 'line_standard_item_identification' documentType. The scheme agency for the standardized ID for the item.","type":"string","minLength":1,"default":"9"},"note":{"title":"Note","description":"A note to add to the document line","type":"string"}}},"EIdentifiers":{"title":"Electronic identifiers","description":"A list of electronic routing identifiers. These are the identifiers used on the Peppol network or for other destinations.","type":"array","items":{"$ref":"#/definitions/RoutingIdentifier"}},"DiscoverableParticipant":{"title":"Discoverable Participant","description":"A participant to be discovered.","type":"object","properties":{"documentTypes":{"title":"DocumentTypes","description":"An array of document types to discover. The default is '[\"invoice\", \"creditnote\"]'. This is ignored when only checking existence.","type":"array","items":{"type":"string","enum":["invoice","creditnote","invoice_response","order","ordering","order_response"]}},"network":{"title":"Network","description":"The network to check. Currently only 'peppol' is supported.","type":"string","minLength":3,"default":"peppol"},"flags":{"title":"Flags","description":"The flags for the check.","type":"object","$ref":"#/definitions/DiscoveryFlag"},"metaScheme":{"title":"Meta Scheme","description":"The meta scheme of the identifier. For Peppol this is always 'iso6523-actorid-upis'.","type":"string","minLength":3,"default":"iso6523-actorid-upis"},"scheme":{"title":"Scheme","description":"The scheme of the identifier. See <<_receiver_identifiers_list>> for a list.","type":"string","minLength":3},"identifier":{"title":"Identifier","description":"The actual identifier.","type":"string","minLength":1}},"required":["scheme","identifier"]},"DiscoveredParticipant":{"title":"Discovered Participant","description":"A public identifier for this customer.","type":"object","properties":{"code":{"title":"Code","description":"The response code.","type":"string","enum":["OK","NOK"]},"email":{"title":"Email","description":"DEPRECATED. Whether or not an 'OK' response means the document will be sent via Peppol, but delivered by email. This happens in the Belgian Hermes system where all identifiers have been registered, but if the receiver hasn't registered with a service provider, the Hermes system will send a PDF created from the electronic invoice and email that. The electronic document will itself not be emailed. Also see https://einvoice.belgium.be/en/article/send-structured-invoices-all-your-customers-hermes[Hermes^].","type":"boolean"}}},"DocumentSubmission":{"title":"Document submission","description":"The document you want Storecove to send, with some meta-data.","type":"object","properties":{"routing":{"title":"Routing destinations","description":"Specifies where the document is to be sent. Can be electronic identifiers or email addresses.","$ref":"#/definitions/Routing"},"legalEntityId":{"title":"LegalEntity Id","description":"The id of the LegalEntity this document should be sent on behalf of. Either legalEntityId or forDocumentGuid is mandatory, unless the document type uses forDocumentSubmissionGuid instead.","type":"integer"},"receiveGuid":{"title":"Receive GUID","description":"DEPRECATED. The GUID that was in the received_document webhook. Use forDocumentGuid instead.","type":"string"},"forDocumentGuid":{"title":"For Document GUID","description":"The GUID that was in the received_document webhook. Use this field for document types that refer to a received document, such as InvoiceResponse and OrderResponse. Provide forDocumentGuid instead of legalEntityId for those flows.","type":"string"},"forDocumentSubmissionGuid":{"title":"For DocumentSubmission GUID","description":"The GUID of an earlier DocumentSubmission that this submission refers to. For documentType=payment_received_notification, this must be the GUID of the original French invoice DocumentSubmission the payment notification is for. For this document type, provide forDocumentSubmissionGuid instead of legalEntityId or forDocumentGuid.","type":"string"},"idempotencyGuid":{"title":"Idempotency GUID","description":"A guid that you generated for this DocumentSubmission to achieve idempotency. If you submit multiple documents with the same idempotencyGuid, only the first one will be processed and any subsequent ones will trigger an HTTP 422 Unprocessable Entity response.","type":"string","minLength":36,"maxLength":36},"createPrimaryImage":{"title":"Create Primary Image","description":"DEPRECATED. In the future we will no longer support creating PDF invoices. Whether or not to create a primary image (PDF) if one is not provided. For customers who started from April 1st 2023, the default is false. For customers who started before that, the default is true.","type":"boolean"},"attachments":{"title":"Attachments","description":"DEPRECATED. Use the attachments array inside the 'document' property. An array of attachments. You may provide up to 10 attchments, but the total size must not exceed 100MB after Base64 encoding.","type":"array","maxItems":10,"items":{"$ref":"#/definitions/Attachment"}},"document":{"$ref":"#/definitions/SendableDocument"}}},"DocumentSubmissionResult":{"title":"Document submission result","description":"The result of a document submission","type":"object","properties":{"guid":{"title":"GUID","description":"A (V4) GUID for the document submission","type":"string"}}},"EnvelopedData":{"title":"Enveloped Data","description":"A document to send, in base64 encoded format, to be wrapped in an envelope.","type":"object","properties":{"application":{"title":"Application","description":"The application to use to send the document","type":"string","enum":["peppol","dbnalliance"]},"processId":{"title":"Process Id","description":"The process id of the document.","type":"string"},"processIdSchemeId":{"title":"Process Id Scheme Id","description":"The process id scheme id of the document.","type":"string","enum":["cenbii-procid-ubl"]},"documentId":{"title":"Document Id","description":"The document type id of the document.","type":"string"},"documentIdSchemeId":{"title":"Document Id Scheme Id","description":"The document id scheme id of the document.","type":"string","enum":["busdox-docid-qns","peppol-doctype-wildcard","bdx-docid-qns"]},"document":{"title":"Document","description":"The base64 encoded version of the document.","type":"string","minLength":5},"envelope":{"$ref":"#/definitions/Envelope","description":"Information for the envelope of the document."},"metadata":{"$ref":"#/definitions/Metadata","description":"Metadata about the document, used in the UI and reporting."}},"required":["application","processId","processIdSchemeId","documentId","documentIdSchemeId","document","envelope","metadata"]},"RawDocumentData":{"title":"Raw Document Data","description":"A document to send, in base64 encoded format.","type":"object","properties":{"parse":{"title":"Parse","description":"DEPRECATED. Will be ignored.","type":"boolean","default":true},"parseStrategy":{"title":"Parse Strategy","description":"How to parse the document.","type":"string","enum":["ubl","cii","idoc","setu14"]},"document":{"title":"Document","description":"The base64 encoded version of the document.","type":"string","minLength":5}},"required":["document"]},"ReceivableDocument":{"title":"Receivable Document","description":"The received document.","type":"object","properties":{"documentType":{"title":"Document Type","description":"The type of document received.","type":"string","enum":["invoice","order"]},"source":{"title":"Source","description":"The source of the document.","type":"string","enum":["self","peppol","dbnalliance","ro-anaf","finvoice","it-sdi"]},"invoice":{"$ref":"#/definitions/Invoice","description":"An invoice or creditnote."},"order":{"$ref":"#/definitions/DocumentOrder","description":"An order."}},"required":["documentType","source"]},"SendableDocument":{"title":"Sendable Document","description":"The document to send.","type":"object","properties":{"documentType":{"title":"Document Type","description":"The type of document to be sent.","type":"string","enum":["enveloped_data","invoice","invoice_response","cdar","ppf_cdar","invoice_report","order","fr_e_report","payment_received_notification"]},"invoice":{"$ref":"#/definitions/Invoice","description":"An invoice or creditnote."},"invoiceResponse":{"$ref":"#/definitions/DocumentInvoiceResponse","description":"An invoice response."},"invoiceReport":{"$ref":"#/definitions/DocumentInvoiceReport"},"paymentReceivedNotification":{"type":"object","description":"A French payment received notification. Only mode=auto is currently supported. Provide the referenced invoice submission via the top-level forDocumentSubmissionGuid field.","properties":{"mode":{"type":"string","enum":["auto"]}},"required":["mode"]},"order":{"$ref":"#/definitions/DocumentOrder","description":"An order.."},"rawDocumentData":{"$ref":"#/definitions/RawDocumentData"},"envelopedData":{"$ref":"#/definitions/EnvelopedData"}},"required":["documentType"]},"Transportable":{"title":"Transportable","description":"A transportable document. Currently only used for receiving.","type":"object","properties":{"legalEntityId":{"title":"LegalEntity Id","description":"The id of the LegalEntity this document should be sent on behalf of or was received for.","type":"integer"},"direction":{"title":"Transport Direction","description":"The direction of the document.","type":"string","enum":["in","out"]},"guid":{"title":"GUID","description":"The GUID of the document that was received","type":"string"},"original":{"title":"Original","description":"The document as originally received. Process this as a blob. Only present if requested.","type":"string"},"document":{"title":"Receivable Document","description":"The parsed received document. Not present if the original was requested.","$ref":"#/definitions/ReceivableDocument"}}},"InvoiceData":{"title":"Invoice Data","description":"DEPRECATED. Use RawDocumentData. The invoice to send, in base64 encoded format. Provide either invoice, or invoiceData, but not both.","type":"object","properties":{"conversionStrategy":{"title":"Conversion Strategy","description":"How to interpret the document.","type":"string","enum":["ubl","cii","idoc","setu14"]},"document":{"title":"Document","description":"The base64 encoded version of the document.","type":"string","minLength":5}}},"InvoiceRecipient":{"title":"Recipient ids","description":"DEPRECATED. Use the Routing object. The different ways to send the invoice to the recipient. The publicIdentifiers are used to send via the Peppol network, if the recipient is not registered on the Peppol network, the invoice will be sent to the email addresses in the emails property. This property is only mandatory when sending the invoice data using the <<_openapi_invoice>> property, not when sending using the <<_openapi_invoicedata>> property, in which case this information will be extracted from the <<_openapi_invoicedata>> object. If you do specify an <<_openapi_invoicerecipient>> object and an <<_openapi_invoicedata>> object, the data from the two will be merged.","type":"object","properties":{"publicIdentifiers":{"title":"Public Identifiers","description":"The public identifiers for this invoice recipient. These are the identifiers used on the Peppol network. Note that when sending invoices with VAT (or with a taxExemptReason), a receiver VAT number is required and that should be one of these publicIdentifiers.","$ref":"#/definitions/PublicIdentifiers"},"emails":{"title":"Fallback email","description":"The email addresses the invoice should be sent to if none of the other identifiers can be used","type":"array","items":{"title":"Email","description":"The email address the invoice should be sent to","type":"string","format":"email"}}}},"InvoiceRecipientPreflight":{"title":"Invoice recipient preflight","description":"Identifies the invoice recipient to preflight","type":"object","properties":{"publicIdentifiers":{"description":"The public identifiers for this invoice recipient.","$ref":"#/definitions/PublicIdentifiers"}}},"InvoiceSubmission":{"title":"Invoice submission","description":"DEPRECATED. The invoice you want Storecove to process, with some meta-data.","type":"object","properties":{"createPrimaryImage":{"title":"Create Primary Image","description":"DEPRECATED. In the future we will no longer support creating PDF invoices. Whether or not to create a primary image (PDF) if one is not provided. For customers who started from December 1st 2022, the default is false. For customers who started before that, the default is true.","type":"boolean"},"mode":{"title":"Mode","description":"DEPRECATED.","type":"string","enum":["direct"]},"supplierId":{"title":"Supplier id","description":"DEPRECATED.","type":"integer"},"legalSupplierId":{"title":"The legal supplier id","description":"DEPRECATED. Use legalEntityId","type":"integer"},"legalEntityId":{"title":"The LegalEntity id","description":"The id of the LegalEntity this invoice should be sent for.","type":"integer"},"idempotencyGuid":{"title":"Idempotency GUID","description":"A guid that you generated for this InvoiceSubmission to achieve idempotency. If you submit multiple documents with the same idempotencyGuid, only the first one will be processed.","type":"string","minLength":36,"maxLength":36},"invoiceRecipient":{"title":"Invoice recipient","description":"DEPRECATED. Use the routing and accountingCustomerParty.publicIdentifiers properties.","$ref":"#/definitions/InvoiceRecipient"},"routing":{"title":"Routing destinations","description":"Specifies where the invoice is to be sent. Can be electronic identifiers or email addresses.","$ref":"#/definitions/Routing"},"attachments":{"title":"Attachments","description":"An array of attachments. You may provide up to 10 attchments, but the total size must not exceed 100MB after Base64 encoding.","type":"array","maxItems":10,"items":{"$ref":"#/definitions/Attachment"}},"document":{"title":"Document","description":"DEPRECATED. Use attachments.","type":"string"},"documentUrl":{"title":"Document Url","description":"DEPRECATED. Use attachments.","type":"string","format":"uri"},"invoice":{"$ref":"#/definitions/Invoice"},"invoiceData":{"$ref":"#/definitions/InvoiceData"}}},"InvoiceSubmissionResult":{"title":"Invoice submission result","description":"The result of an invoice submission","type":"object","properties":{"guid":{"title":"GUID","description":"A (V4) GUID for the invoice submission","type":"string"}}},"PreflightInvoiceRecipientResult":{"title":"Preflight invoice recipient result","description":"The result of preflighting an invoice recipient","type":"object","properties":{"code":{"title":"Result code","description":"The result code of the preflight request","type":"string","enum":["ok","nok"]}}},"Envelope":{"title":"Envelope","description":"Information for the envelope of the document.","type":"object","properties":{"sender":{"title":"Sender","description":"The sender of the document. For UBL documents, this is the AccountingSupplierParty/EndpointID.","type":"string","pattern":"^\\d{4}:[A-Za-z0-9\\-\\._~]{1,135}$|^[\\w:]{3,12}::[A-Za-z0-9\\-\\._~]{1,135}$"},"receiver":{"title":"Receiver","description":"The receiver of the document. For UBL documents, this is the AccountingCustomerParty/EndpointID.","type":"string","pattern":"^\\d{4}:[A-Za-z0-9\\-\\._~]{1,135}$|^[\\w:]{3,12}::[A-Za-z0-9\\-\\._~]{1,135}$"},"typeVersion":{"title":"Type Version","description":"The version of the type. Only used and mandatory for EDIFACT and X12 documents.","type":"string","enum":["D24A","D23A","D22A","D22B","D21A","D21B","D20A","D20B","D19A","D19B","D18A","D18B","D17A","D17B","D16A","D16B","D15A","D15B","D14A","D14B","D13A","D13B","D12A","D12B","D11A","D11B","D10A","D10B","D09A","D09B","D08A","D08B","D07A","D07B","D06A","D06B","D05A","D05B","D04A","D04B","D03A","D03B","D02A","D02B","D01A","D01B","D01C","D00A","D00B","D99A","D99B","D98A","D98B","D97A","D97B","D96A","D96B","D95A","D95B","D94A","D94B","D93A","93-2","S93A","92-1","91-1","91-2","90-1","90-2","88-1","001000","002042","002041","002040","002031","002003","002002","002001","002000","003072","003071","003070","003062","003061","003060","003052","003051","003050","003042","003041","003040","003032","003031","003030","003022","003021","003020","003012","003011","003010","003000","004062","004061","004060","004052","004051","004050","004042","004041","004040","004032","004031","004030","004022","004021","004020","004012","004011","004010","004000","005052","005051","005050","005042","005041","005040","005032","005031","005030","005022","005021","005020","005012","005011","005010","005000","006052","006051","006050","006042","006041","006040","006032","006031","006030","006022","006021","006020","006012","006011","006010","006000","007060","007050","007042","007041","007040","007032","007031","007030","007022","007021","007020","007012","007011","007010","007000","008060","008050","008040","008030","008020","008010","008000"]},"mimeType":{"title":"Mime Type","description":"The mime type of the document. One of the types on https://www.iana.org/assignments/media-types/media-types.xhtml startin 'application'. Only used and mandatory for BILATERAL documents.","type":"string","pattern":"^application/.+$"}},"required":["sender","receiver"]},"Metadata":{"title":"Metadata","description":"Metadata about the document, used in the UI and reporting.","type":"object","properties":{"documentNumber":{"title":"Document Number","description":"The number of the document. For UBL documents, this is the Invoice/ID or CreditNote/ID.","type":"string"},"documentDate":{"title":"Document Date","description":"The date of the document. For UBL documents, this is the Invoice/IssueDate or CreditNote/IssueDate.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"receiverName":{"title":"Receiver Name","description":"The name of the receiver of the document. For UBL documents, this is the Invoice/AccountingCustomerParty/PartyName/Name or CreditNote/AccountingCustomerParty/PartyName/Name.","type":"string","minLength":2,"maxLength":128},"receiverCountry":{"title":"Receiver Country","description":"The country of the receiver of the document in ISO 3166-1 Alpha-2 format. For UBL documents, this is the Invoice/AccountingCustomerParty/PostalAddress/Country/IdentificationCode or CreditNote/AccountingCustomerParty/PostalAddress/Country/IdentificationCode.","type":"string","pattern":"^[A-Z0-9]{2}$"},"payloadType":{"title":"Payload Type","description":"The type of payload.","type":"string","enum":["Invoice","CreditNote","InvoiceResponse","Order","OrderResponse","DespatchAdvice","OrderBalance","OrderChange","OrderCancellation","Other"]}},"required":["documentNumber","documentDate","receiverName","receiverCountry","payloadType"]},"LineAllowanceCharge":{"title":"Allowance or Charge","type":"object","properties":{"amountExcludingTax":{"title":"Amount Excluding Tax","description":"The amount for the allowance or charge, excluding tax.","type":"number"},"baseAmountExcludingTax":{"title":"Base Amount Excluding Tax","description":"The base amount for the allowance or charge, excluding tax.","type":"number"},"reason":{"title":"Reason","description":"The reason for the allowance or charge, free text","type":"string"},"reasonCode":{"title":"Reason Code","description":"DEPRECATED. Do not use. Contact Storecove first if you want to use this field.","type":"string"}},"required":["amountExcludingTax"]},"NetworkSettings":{"title":"Network Settings","description":"Settings for an additional routing network.","type":"object","properties":{"scheme":{"title":"enabled","description":"Whether or not the network is enabled","type":"boolean"},"mock":{"title":"Mock","description":"Whether or not to mock the network, if possible.","type":"boolean","default":false}},"required":["enabled"]},"AccountingCustomerParty":{"title":"Customer","description":"The customer receiving the document.","type":"object","properties":{"party":{"$ref":"#/definitions/Party"},"publicIdentifiers":{"title":"Public identifiers","description":"A list of legal and tax identifiers for this customer.","type":"array","items":{"$ref":"#/definitions/PublicIdentifier"}}},"required":["party"]},"AccountingSupplierParty":{"title":"Supplier","description":"The supplier sending the invoice. When you are doing the sending, most data for the AccountingSupplierParty is taken from the LegalEntity in the Storecove database, where your sender identity resides and has been validated. However, we provide a limited number of fields (mainly contact fields) here that you can specify on a document-by-document basis. For receiving, the full party object can be received.","type":"object","properties":{"party":{"$ref":"#/definitions/Party"},"publicIdentifiers":{"title":"Public identifiers","description":"A list of legal and tax identifiers for this supplier.","type":"array","items":{"$ref":"#/definitions/PublicIdentifier"}}}},"BuyerCustomerPartyOrder":{"title":"Buyer","description":"The buyer sending the order.","type":"object","properties":{"party":{"$ref":"#/definitions/SenderParty"}},"required":["party"]},"Contact":{"title":"Contact","description":"Contact details for the invoice","type":"object","properties":{"firstName":{"title":"First name","type":"string"},"lastName":{"title":"Last name","type":"string"},"email":{"title":"Email address","type":"string","format":"email"},"phone":{"title":"Phone number","type":"string","maxLength":24},"id":{"title":"Id","description":"Only supported for AccountingCustomerParty.","type":"string","maxLength":20}}},"Party":{"title":"Party","description":"A party that can receive or send invoices","type":"object","properties":{"companyName":{"title":"Company name","description":"The name of the company transporting the invoice","type":"string","minLength":2},"registrationName":{"title":"Registration name","description":"The registration name of the company transporting the invoice","type":"string"},"additionalLegalInformation":{"title":"Additional Legal Information","description":"Additional legal information relevant for the Seller.","type":"string","maxLength":512},"classificationCode":{"title":"Classification Code","description":"The classification code of the company transporting the invoice. This currently is used only for the Malaysia LHDNM application in selfBillingMode. In that case, it becomes the MSIC of the sender of the purchase invoice.","type":"string","pattern":"^[0-9]{5}$"},"address":{"$ref":"#/definitions/Address"},"contact":{"$ref":"#/definitions/Contact"}}},"PublicIdentifier":{"title":"Public identifier","description":"A public identifier for this customer.","type":"object","properties":{"scheme":{"title":"Scheme","description":"The scheme of the identifier. See <<_receiver_identifiers_list>> for a list.","type":"string","minLength":3},"id":{"title":"Identifier","description":"The actual identifier.","type":"string","minLength":1}},"required":["scheme","id"]},"PublicIdentifiers":{"title":"Public identifiers","description":"A list of public identifiers that uniquely identify this customer.","type":"array","items":{"$ref":"#/definitions/PublicIdentifier"}},"ReceiverParty":{"title":"Receiver","description":"The receiver of the document.","type":"object","$ref":"#/definitions/Party"},"SenderParty":{"title":"Sender Party","description":"A party that can send documents","type":"object","properties":{"contact":{"$ref":"#/definitions/Contact"}}},"DeliveryParty":{"title":"Delivery Party","description":"The party receiving the shipment.","type":"object","properties":{"party":{"$ref":"#/definitions/ReceiverParty"},"publicIdentifiers":{"title":"Public identifiers","description":"A list of legal and tax identifiers for this delivery party.","type":"array","items":{"$ref":"#/definitions/PublicIdentifier"}}},"required":["party"]},"OriginatorCustomerParty":{"title":"Buyer","description":"The originator of the document.","type":"object","properties":{"party":{"$ref":"#/definitions/Party"}},"required":["party"]},"OriginatorParty":{"title":"Originator","description":"The originator of the line.","type":"object","properties":{"party":{"title":"Party","description":"","type":"object","companyName":{"title":"Company name","description":"The name of the originator party.","type":"string","minLength":2}},"publicIdentifiers":{"title":"Public identifiers","description":"A list of legal and tax identifiers for the originator party.","type":"array","items":{"$ref":"#/definitions/PublicIdentifier"}}},"required":["party"]},"PayeeParty":{"title":"Payee Party","description":"The party to whom the invoice will be paid. Use this only if necessary, for instance in case of factoring (payment is to the factoring company), bankruptcy (payment is to the bankruptcy estate) or in other special cases.","type":"object","properties":{"party":{"$ref":"#/definitions/Party"},"publicIdentifiers":{"title":"Public identifiers","description":"A list of legal and tax identifiers for this party.","type":"array","items":{"$ref":"#/definitions/PublicIdentifier"}}},"required":["party"]},"SelfBillingBuyerParty":{"title":"Buyer","description":"The buyer sending the invoice. When you are doing the sending, most data for the SelfBillingBuyerParty is taken from the LegalEntity in the Storecove database, where your sender identity resides and has been validated. However, we provide a limited number of fields (mainly contact fields) here that you can specify on a document-by-document basis. For receiving, the full party object can be received. To use this, make sure you set the selfBillingMode flag to true. Note that the old way of providing this data was through the accountingSupplierParty. That is still supported, but strongly discouraged since it is confusing.","type":"object","properties":{"party":{"$ref":"#/definitions/Party"},"publicIdentifiers":{"title":"Public identifiers","description":"A list of legal and tax identifiers for this buyer.","type":"array","items":{"$ref":"#/definitions/PublicIdentifier"}}},"required":["party"]},"SelfBillingSupplierParty":{"title":"Supplier","description":"The supplier receiving the invoice. To use this, make sure you set the selfBillingMode flag to true. Note that the old way of providing this data was through the accountingCustomerParty. That is still supported, but strongly discouraged since it is confusing.","type":"object","properties":{"party":{"$ref":"#/definitions/Party"},"publicIdentifiers":{"title":"Public identifiers","description":"A list of legal and tax identifiers for this supplier.","type":"array","items":{"$ref":"#/definitions/PublicIdentifier"}}}},"SellerSupplierParty":{"title":"Supplier","description":"The party sending the order.","type":"object","properties":{"party":{"$ref":"#/definitions/SenderParty"},"publicIdentifiers":{"title":"Public identifiers","description":"A list of legal and tax identifiers for this customer.","type":"array","items":{"$ref":"#/definitions/PublicIdentifier"}}},"required":["party","publicIdentifiers"]},"PaymentMeans":{"title":"PaymentMeans","description":"A PaymentMeans is a way to pay the invoice.","type":"object","properties":{"code":{"title":"Code","description":"How the invoice has been / will be paid. The code determines which type of PaymentMeans is used and which fields are mandatory.\n++++\n<ul>    <li>        <strong>cash</strong><br/>        The invoice was/is paid in cash.<br/>    </li>    <li>        <strong>bank_cheque</strong><br/>        The invoice was/is paid via a bank cheque.<br/>    </li>    <li>        <strong>cashiers_cheque</strong><br/>        The invoice was/is paid via a cashiers cheque.<br/>    </li>    <li>        <strong>credit_transfer, sepa_credit_transfer</strong><br/>        The amount is to be transfered into a bank account. Relevant additional fields:<br/>        <ul>            <li>                <strong>account</strong><br/>                The account number. For New Zealand, this should hold the full 16 digit bank account number. <strong>Mandatory</strong>.            </li>            <li>                <strong>branche_code</strong><br/>                In case of an IBAN, the account alone number is sufficient. In other cases, like a BBAN, a BIC code or other additional identifier is required. For Australia, the BSB goes here. Optional.            </li>            <li>                <strong>holder</strong><br/>                The account holder name. Optional.            </li>        </ul>        Note that using 'sepa_credit_transfer' will result in the PaymentMeansCode of '58' being used in UBL documents. Otherwise, the more generic '30' will be used.    </li>    <li>        <strong>debit_transfer</strong><br/>        Used for CreditNotes. The amount is to be transfered by the sender of the document into the bank account of the receiver of the document. Relevant additional fields:<br/>        <ul>            <li>                <strong>account</strong><br/>                The account number. For New Zealand, this should hold the full 16 digit bank account number. <strong>Mandatory</strong>.            </li>            <li>                <strong>branche_code</strong><br/>                In case of an IBAN, the account alone number is sufficient. In other cases, like a BBAN, a BIC code or other additional identifier is required. For Australia, the BSB goes here. Optional.            </li>        </ul>    </li>    <li>        <strong>direct_debit, sepa_direct_debit</strong><br/>        Direct debit. Relevant additional fields:<br/>        <ul>            <li>                <strong>account</strong><br/>                The account number from which the funds will be debited. <strong>Mandatory</strong>.            </li>            <li>                <strong>mandate</strong><br/>                The direct debit mandate id. Mandatory.            </li>            <li>                <strong>holder</strong><br/>                The account holder name. Optional.            </li>        </ul>        Note that using 'sepa_direct_debit' will result in the PaymentMeansCode of '59' being used in UBL documents. Otherwise, the more generic '49' will be used.    </li>    <li>        <strong>card, credit_card, bank_card (credit_card, bank_card are deprecated)</strong><br/>        E.g. credit or debit card. Relevant additional fields:<br/>        <ul>            <li>                <strong>account</strong><br/>                The card number, but never more than the last four digits. <strong>Mandatory</strong>.            </li>            <li>                <strong>holder</strong><br/>                The account holder name. Optional.            </li>            <li>                <strong>network</strong><br/>                The payment network, e.g. VISA, SEPA. Optional, but recommended since a default of \"N/A\" may be used if not provided.            </li>        </ul>    </li>    <li>        <strong>online_payment_service</strong><br/>        An online payment service has been or will be used. Relevant additional fields:<br/>        <ul>            <li>                <strong>network</strong><br/>                The payment network, e.g. PayPal. <strong>Mandatory unless url is provided</strong>.            </li>            <li>                <strong>url</strong><br/>                The URL to execute the payment. <strong>Mandatory unless network is provided</strong>.            </li>        </ul>        It is possible to provide both url and network. Note that for UBL, in countries where this payment means is not allowed, this will translate into an AdditionalDocumentReference.Attachment.ExternalReference element.    </li>    <li>        <strong>standing_agreement</strong><br/>        The payment means has been agreed out of band. Relevant additional fields: none.    </li>    <li>        <strong>aunz_npp_payid, aunz_npp (aunz_npp is deprecated)</strong><br/>        Australia/New Zealand New Payments Platform. Relevant additional fields:<br/>        <ul>            <li>                <strong>account</strong><br/>                PayID. May be an email address, ABN, mobile phone number etc. <strong>Mandatory</strong>.            </li>        </ul>    </li>    <li>        <strong>aunz_npp_payto</strong><br/>        Australia/New Zealand New Payments Platform. Relevant additional fields:<br/>        <ul>            <li>                <strong>account</strong><br/>                Account number. <strong>Mandatory</strong>.            </li>            <li>                <strong>mandate</strong><br/>                Mandate/direct debit authority reference/PayTo Agreement. <strong>Mandatory</strong>.            </li>        </ul>    </li>    <li>        <strong>aunz_bpay</strong><br/>        Australia/New Zealand New Payments Platform. Relevant additional fields:<br/>        <ul>            <li>                <strong>account</strong><br/>                Biller code. <strong>Mandatory</strong>.            </li>            <li>                <strong>holder</strong><br/>                The account holder name. Optional.            </li>        </ul>    </li>    <li>        <strong>aunz_postbillpay</strong><br/>        Australia/New Zealand New Payments Platform. Relevant additional fields:<br/>        <ul>            <li>                <strong>account</strong><br/>                Biller code. <strong>Mandatory.</strong>.            </li>            <li>                <strong>holder</strong><br/>                The account holder name. Optional.            </li>        </ul>    </li>    <li>        <strong>aunz_uri</strong><br/>        Australia/New Zealand URI. Relevant additional fields:<br/>        <ul>            <li>                <strong>account</strong><br/>                Payment URI. <strong>Mandatory.</strong>.            </li>            <li>                <strong>holder</strong><br/>                The account holder name. Optional.            </li>        </ul>    </li>    <li>        <strong>se_bankgiro</strong><br/>        Swedish Bankgiro. Relevant additional fields:<br/>        <ul>            <li>                <strong>account</strong><br/>                The account number from which the funds will be debited, 7 or 8 digits. <strong>Mandatory</strong>.            </li>            <li>                <strong>holder</strong><br/>                The account holder name. Optional.            </li>        </ul>        <br/>    </li>    <li>        <strong>se_plusgiro</strong><br/>        Swedish Plusgiro. Relevant additional fields:<br/>        <ul>            <li>                <strong>account</strong><br/>                The account number from which the funds will be debited, 2 - 8 digits. <strong>Mandatory</strong>.            </li>            <li>                <strong>holder</strong><br/>                The account holder name. Optional.            </li>        </ul>        <br/>    </li>    <li>        <strong>sg_giro</strong><br/>        Singapore GIRO-system (direct debit). Relevant additional fields: none.    </li>    <li>        <strong>sg_card</strong><br/>        Singapore CreditCard payment. Relevant additional fields: none.    </li>    <li>        <strong>sg_paynow</strong><br/>        Singapore PayNow Corporate.  Relevant additional fields:<br/>        <ul>            <li>                <strong>account</strong><br/>                The UEN, format: UENxxxxxxxxxx. <strong>Mandatory</strong>.            </li>        </ul>    </li>    <li>        <strong>it_mav</strong><br/>        Italy MAV payment.    </li>    <li>        <strong>it_pagopa</strong><br/>        Italy PagoPA payment.    </li></ul>\n++++\n","type":"string","enum":["credit_transfer","sepa_credit_transfer","debit_transfer","direct_debit","sepa_direct_debit","card","bank_card","credit_card","online_payment_service","cash","bank_cheque","cashiers_cheque","standing_agreement","aunz_npp","aunz_npp_payid","aunz_npp_payto","aunz_bpay","aunz_postbillpay","aunz_uri","se_bankgiro","se_plusgiro","sg_giro","sg_card","sg_paynow","it_mav","it_pagopa","nl_ga_beneficiary","nl_ga_gaccount","undefined"]},"account":{"title":"Account number","description":"The account number.","type":"string"},"branche_code":{"title":"Branch code","description":"The bank branch code. Not required for IBAN numbers. Often referred to as Swift or Bic code.","type":"string"},"holder":{"title":"Account holder","description":"The name of the account holder.","type":"string"},"network":{"title":"Network","description":"The name of the card network, e.g. VISA.","type":"string"},"mandate":{"title":"Mandate","description":"The direct debit mandate code.","type":"string"},"sepa_creditor_reference":{"title":"SEPA Creditor Reference","description":"The SEPA creditor reference.","type":"string"},"paymentId":{"title":"Payment Id","description":"The payment id that you will use to match the payment against the invoice.","type":"string"},"amount":{"title":"Amount","description":"The amount to be paid for this category. Only used for Dutch G-Account invoices. The amount nl_ga_beneficiary + amount nl_ga_gaccount must add up to the amountExcludingVat","type":"number"}},"required":["code"]},"PaymentTerm":{"title":"PaymentTerm","description":"A PaymentTerm is a single term for the payment terms. Each term consists of the number of days within which the invoice must be settled and a discount percentage that applies if the invoice is settled within those days. If the amount to be calculated is based only on part of the amount due, the base amount for calculating the cash discount or late-payment interest must be specified as the baseAmount.","type":"object","properties":{"settlementDays":{"title":"Days","description":"The number of days within which the invoice must be settled for the term to apply.","type":"integer"},"discountPercentage":{"title":"Percentage","description":"The discount percentage that applies if the invoice is settled within the required number of days. Provide only one of discountPercentage or surchargePercentage.","type":"number"},"surchargePercentage":{"title":"Percentage","description":"The surcharge percentage that applies if the invoice is settled after the required number of days. Provide only one of discountPercentage or surchargePercentage.","type":"number"},"baseAmount":{"title":"Base Amount","description":"The base amount on which the discount percentage is applied.","type":"number"},"note":{"title":"Note","description":"The note for this payment term.","type":"string","maxLength":1024}},"required":["settlementDays"]},"PaymentTerms":{"title":"Payment Terms","description":"The payment terms of the document. Note that not all syntaxes support payment terms, so in some syntaxes they will converted into a payment terms note and it is even possible that they have to be omitted completely, for instance in many eReporting syntaxes (where they don't play a role anyway).\n++++\n<br/>\n++++\nProvide either the note or the terms, but not both.","type":"object","properties":{"note":{"title":"Payment Terms Note","description":"The note for the payment terms.","type":"string"},"terms":{"title":"Payment Terms Terms","description":"The terms for the payment terms.","type":"array","items":{"$ref":"#/definitions/PaymentTerm"}}}},"PrepaidPayment":{"title":"PrepaidPayment","description":"A PrepaidPayment is a single prepaid payment. Each prepaid payment consists of at least the amount of the payment.","type":"object","properties":{"amount":{"title":"Amount","description":"The amount of the payment.","type":"number"},"date":{"title":"Date","description":"The date on which the payment was made.","type":"string","format":"date"},"time":{"title":"Time","description":"The time at which the payment was made.","type":"string","pattern":"^[0-9]{2}:[0-9]{2}:[0-9]{2}$"},"timeZone":{"title":"Time Zone","description":"The time zone at which the payment was made. Format: ±zzzz, where ±zzzz is the difference from UTC, e.g. +0100 or -0900 etc. Mandatory if time is provided.","type":"string","pattern":"^[+-]\\d{4}$"},"reference":{"title":"Reference","description":"The reference of the payment.","type":"string","minLength":1,"maxLength":128}},"required":["amount"]},"Reference":{"title":"Reference","description":"A reference to a document.","type":"object","properties":{"documentType":{"title":"Document Type","description":"The type of the referenced document. The following types are supported:\n++++\n<ul>    <li>        <b>purchase_order</b> (document level, Invoice)        <p>A reference to an order for this document, assigned by the buyer. Note that this often is a key field, since many receivers of invoices will use this field to automatically match the invoice to an order they placed. Many receivers refuse invoices that cannot be automatically matched, in particular government agencies. So it is highly recommended to fill this field whenever possible.</p>    </li>    <li>        <b>billing</b> (document level, Invoice)        <p>A reference to a billing document. For instance, credit notes may refer to an invoice they are a credit note for.</p>    </li>    <li>        <b>billing_uuid</b> (document level, Invoice)        <p>DEPRECATED. Use the billingUuid property of the 'billing' reference. A UUID reference to a billing document. For instance, credit notes may refer to an invoice they are a credit note for.</p>    </li>    <li>        <b>sales_order</b> (document level, Invoice + Order)        <p>A reference to an order for this document, assigned by the seller.</p>    </li>    <li>        <b>buyer_reference</b> (document level, Invoice, Order)        <p>The buyer's reference. Used for internal routing by the receiver. For orders, this becomes the customer reference which the receiver of the order should put back in the buyer reference field in the invoice.</p>    </li>    <li>        <b>additional</b> (document level, Invoice, Order)        <p>An additional reference. For UBL, this translates into an AdditionalDocumentReference without a EmbeddedDocumentBinaryObject. For the latter, use the attachments array.</p>    </li>    <li>        <b>contract</b> (document level, Invoice + Order)        <p>A reference to a contract or framework agreement that this document relates to.</p>    </li>    <li>        <b>despatch_advice</b> (document level, Invoice)        <p>A reference to a despatch advice for this document. In the FatturaPA, this is what will become the DDT.</p>    </li>    <li>        <b>originator</b> (document level, Invoice + Order)        <p>A reference to an originator document for this invoice.</p>    </li>    <li>        <b>receipt</b> (document level, Invoice)        <p>A reference to a receipt document for this document.</p>    </li>    <li>        <b>project</b> (document level, Invoice)        <p>A reference to a project document for this document.</p>    </li>    <li>        <b>quotation</b> (document level, Order)        <p>A reference to a quotation document for this document.</p>    </li>    <li>        <b>replaced_order</b> (document level, Order)        <p>A reference to the initial order that was rejected and a new order is issued.        </p>    </li>    <li>        <b>payment_url</b> (document level, Invoice)        <p>A to a payment URL for the invoice.</p>    </li>    <li>        <b>item_classification_code</b> (line level)        <p>A reference to a commodity classification / item classification code for this line. Note that in combination with the documentIdListId these can be used for Malaysia LHDNM to provide the product classification code (documentIdListId=CLASS) and the product tariff code (documentIdListId=PTC)</p>    </li>    <li>        <b>item_commodity_code</b> (line level)        <p>A reference to a commodity classification / commodity code for this line.</p>    </li>    <li>        <b>item_specification</b> (line level)        <p>A referece to an item specification document</p>    </li>    <li>        <b>line_document_reference</b> (line level)        <p>A reference to another document for this line.</p>    </li>    <li>        <b>line_standard_item_identification</b> (line level)        <p>A standard item identification.</p>    </li>    <li>        <b>line_sellers_item_identification</b> (line level)        <p>The seller's item identification.</p>    </li>    <li>        <b>line_buyers_item_identification</b> (line level)        <p>The buyer's item identification.</p>    </li>    <li>        <b>line_purchase_order</b> (line level)        <p>A reference to an order for this line, assigned by the buyer. Note not all outgoing document formats support this, so they may end up concatenated at the invoice level.</p>    </li></ul>\n++++\n","type":"string","enum":["purchase_order","replaced_order","buyer_reference","billing","billing_uuid","sales_order","contract","despatch_advice","originator","receipt","project","quotation","payment_url","additional","certified_exporter_authorization","free_trade_agreement","my_customs_form_1_9","my_customs_form_2","item_classification_code","item_commodity_code","item_specification","line_document_reference","line_standard_item_identification","line_sellers_item_identification","line_buyers_item_identification","line_purchase_order"]},"documentTypeCode":{"title":"Document Type Code","description":"The code of the referenced document type. Only used for documentType = 'line_document_reference'.","type":"string","pattern":"^uncl1001_[0-9]{1,3}$"},"documentId":{"title":"DocumentId","description":"The id of the referenced document.","type":"string"},"documentUuid":{"title":"DocumentUuid","description":"The UUID of the referenced document.","type":"string"},"documentIdSchemeId":{"title":"DocumentId Scheme Id","description":"The scheme id of the id of the referenced document.","type":"string"},"documentIdSchemeAgencyId":{"title":"DocumentId SchemeAgencyId","description":"The the agency id of the scheme id of the id of the referenced document.","type":"string"},"documentIdSchemeVersionId":{"title":"DocumentId SchemeVersionId","description":"The version id of the scheme id of the id of the referenced document.","type":"string"},"documentIdListId":{"title":"DocumentId ListId","description":"The list id of the id of the referenced document.","type":"string"},"documentIdListAgencyId":{"title":"DocumentId ListAgencyId","description":"The agency id of the list id of the id of the referenced document.","type":"string"},"documentIdListVersionId":{"title":"DocumentId ListVersionId","description":"The version id of the list id of the id of the referenced document.","type":"string"},"lineId":{"title":"LineId","description":"The line in the referenced document.","type":"string"},"issueDate":{"title":"Issue Date","description":"The issue date of the referenced document.","type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"},"documentDescription":{"title":"Document Description","description":"A description for the referenced document.","type":"string","minLength":2,"maxLength":1024}},"required":["documentType"]},"Routing":{"title":"Recipient ids","description":"The different ways to send the invoice to the recipient. The publicIdentifiers are used to send via the Peppol network, if the recipient is not registered on the Peppol network, the invoice will be sent to the email addresses in the emails property. This property is only mandatory when sending the invoice data using the <<_openapi_invoice>> property, not when sending using the <<_openapi_invoicedata>> property, in which case this information will be extracted from the <<_openapi_invoicedata>> object. If you do specify an <<_openapi_invoicerecipient>> object and an <<_openapi_invoicedata>> object, the data from the two will be merged.","type":"object","properties":{"eIdentifiers":{"title":"Electronic Identifiers","description":"The electronic identifiers for this invoice recipient. These are the identifiers used on the Peppol and DBNAlliance networks.","$ref":"#/definitions/EIdentifiers"},"networks":{"title":"Networks","description":"Any additional networks to consider for routing","type":"array","items":{"$ref":"#/definitions/RoutingNetwork"},"minItems":1},"emails":{"title":"Fallback email","description":"The email addresses the invoice should be sent to if none of the other identifiers can be used","type":"array","items":{"title":"Email","description":"The email address the invoice should be sent to","type":"string","format":"email"}},"clearWithoutSending":{"title":"Clear Without Sending","description":"If you wish to send the document yourself in a Y-flow, use this flag. Wait for the 'cleared' webhook and use the <<_openapi_show_document_submission_evidence>> endpoint to retrieve the clearing evidence. This will include a sendable document.","type":"boolean","default":false}}},"RoutingIdentifier":{"title":"Routing Identifier","description":"An electronic routing identifier.","type":"object","properties":{"scheme":{"title":"Scheme","description":"The scheme of the identifier. See <<_receiver_identifiers_list>> for a list.","type":"string","minLength":3},"id":{"title":"Identifier","description":"The actual identifier.","type":"string","minLength":1},"role":{"title":"Role","description":"The role of the identifier. Only used for B2G sending to ES.","type":"string","enum":["es_01_fiscal","es_02_receptor","es_03_pagador"]}},"required":["scheme","id"]},"RoutingNetwork":{"title":"Routing Network","description":"An additional network to consider for routing.","type":"object","properties":{"scheme":{"title":"application","description":"The name of the network","type":"string","minLength":3},"settings":{"title":"Settings","description":"The settings for the network.","$ref":"#/definitions/NetworkSettings"}},"required":["application","settings"]},"Tax":{"type":"object","properties":{"amount":{"title":"Amount of Tax","description":"The amount of tax. Mandatory if taxSystem == 'tax_line_amounts'. However, it is best to use taxSystem tax_line_percentages and provide only the percentage, not the actual amount. The amount is then provided at the invoice level, in the taxSubtotals element.","type":"number"},"percentage":{"title":"Percentage Tax","description":"The percentage Tax. This should be a valid Tax percentage in the country at the time of the issueDate of this invoice. Mandatory if taxSystem == 'tax_line_percentages'","type":"number"},"country":{"$ref":"#/definitions/Country"},"category":{"title":"Tax category","description":"The allowed values depend on the country of the tax:\n++++\n<ul>    <li>        AE:        <ul>            <li>standard (5%)</li>            <li>standard_additional(5%)</li>            <li>reverse_charge (0%)</li>            <li>zero_rated (0%)</li>            <li>exempt (0%)</li>            <li>export (0%)</li>            <li>outside_scope (0%)</li>        </ul>    </li>    <li>        AU:        <ul>            <li>standard (10%, 5.5%)</li>            <li>zero_rated (0%)</li>            <li>exempt (0%)</li>            <li>export (0%)</li>            <li>outside_scope (0%)</li>        </ul>    </li>    <li>        EU:        <ul>            <li>standard (percentages country dependent)</li>            <li>zero_rated (0%)</li>            <li>reverse_charge (0%)</li>            <li>intra_community (0%)</li>            <li>exempt (0%)</li>            <li>export (0%)</li>            <li>outside_scope (0%)</li>        </ul>    </li>    <li>        EU/IT:        <ul>            <li>standard</li>            <li>zero_rated (0%)</li>            <li>reverse_charge (0%)</li>            <li>intra_community (0%)</li>            <li>exempt (0%)</li>            <li>export (0%)</li>            <li>outside_scope (0%)</li>            <li>bollo_virtuale (only at the invoice level and with mandatory amount: €2.00)</li>        </ul>    </li>    <li>        IN:        <ul>            <li>igst (28%, 18%, 12%, 5%, 3%, 0.25%)</li>            <li>sgst (14%, 9%, 6%, 2.5%, 1.5%)</li>            <li>cgst (14%, 9%, 6%, 2.5%, 1.5%)</li>            <li>cess (any percentage)</li>            <li>state_cess (any percentage)</li>            <li>reverse_charge (0%)</li>            <li>exempt (0%)</li>            <li>export (0%)</li>            <li>outside_scope (0%)</li>            <li>zero_rated (0%)</li>        </ul>    </li>    <li>        JP:        <ul>            <li>standard (10%, 8%)</li>            <li>exempt (0%)</li>            <li>export (0%)</li>            <li>outside_scope (0%)</li>        </ul>    </li>    <li>        MX:        <ul>            <li>standard (16%)</li>            <li>exempt (0%)</li>            <li>export (0%)</li>            <li>outside_scope (0%)</li>            <li>ieps</li>            <li>wht</li>        </ul>    </li>    <li>        MY:        <ul>            <li>sales (5%, 10%) ⮕ LHDNM '01', Peppol 'T'            <li>sales_zero (0%) ⮕ LHDNM '01', Peppol 'E'            <li>service (6%, 8%) ⮕ LHDNM '02', Peppol 'T'            <li>service_zero (0%) ⮕ LHDNM '02', Peppol 'E'            <li>tourism (any amount) ⮕ LHDNM '03', Peppol 'T'            <li>high_value_goods (any percentage) ⮕ LHDNM '04', Peppol 'T'            <li>low_value_goods (10%) ⮕ LHDNM '05', Peppol 'T'            <li>zero_rated (0%) ⮕ LHDNM '06', Peppol 'E'            <li>exempt (0%) ⮕ LHDNM 'E', Peppol 'E'            <li>export (0%) ⮕ LHDNM 'E', Peppol 'E'            <li>outside_scope (0%) ⮕ LHDNM '06', Peppol 'O'        </ul>    </li>    <li>        NZ:        <ul>            <li>standard (15%)</li>            <li>zero_rated (0%)</li>            <li>exempt (0%)</li>            <li>export (0%)</li>            <li>outside_scope (0%)</li>        </ul>    </li>    <li>        SG:        <table>            <tr>                <th>category</th>                <th>percentage</th>                <th>sales invoice</th>                <th>purchase invoice</th>            </tr>            <tr>                <td>standard</td>                <td>9%</td>                <td>SR</td>                <td>TX</td>            </tr>            <tr>                <td>outside_scope</td>                <td>0%</td>                <td>OS</td>                <td>OP</td>            </tr>            <tr>                <td>zero_rated</td>                <td>0%</td>                <td>ZR</td>                <td>ZP</td>            </tr>            <tr>                <td>not_registered</td>                <td>0%</td>                <td>NG</td>                <td>NR</td>            </tr>            <tr>                <td>deemed_supply</td>                <td>9%</td>                <td>DS</td>                <td></td>            </tr>            <tr>                <td>srca_c</td>                <td>9%</td>                <td>SRCA-C</td>                <td></td>            </tr>            <tr>                <td>srovr_rs</td>                <td>9%</td>                <td>SROVR-RS</td>                <td></td>            </tr>            <tr>                <td>srovr_lvg</td>                <td>9%</td>                <td>SROVR-LVG</td>                <td></td>            </tr>            <tr>                <td>srlvg</td>                <td>9%</td>                <td>SRLVG</td>                <td></td>            </tr>            <tr>                <td>srca_s</td>                <td>0%</td>                <td>SRCA-S</td>                <td></td>            </tr>            <tr>                <td>regulation33_exempt</td>                <td>0%</td>                <td>ES33</td>                <td></td>            </tr>            <tr>                <td>nonregulation33_exempt</td>                <td>0%</td>                <td>ESN33</td>                <td></td>            </tr>            <tr>                <td>export</td>                <td>0%</td>                <td>ZR</td>                <td></td>            </tr>            <tr>                <td>not_applicable</td>                <td>0%</td>                <td>NA</td>                <td></td>            </tr>            <tr>                <td>standard_ca (experimental)</td>                <td>9%</td>                <td></td>                <td>TXCA</td>            </tr>            <tr>                <td>standard_na (experimental)</td>                <td>9%</td>                <td></td>                <td>TXNA</td>            </tr>            <tr>                <td>standard_re (experimental)</td>                <td>9%</td>                <td></td>                <td>TX-RE</td>            </tr>            <tr>                <td>standard_n33 (experimental)</td>                <td>9%</td>                <td></td>                <td>TX-N33</td>            </tr>            <tr>                <td>standard_33 (experimental)</td>                <td>9%</td>                <td></td>                <td>TX-ESS</td>            </tr>            <tr>                <td>import_service (experimental)</td>                <td>9%</td>                <td></td>                <td>TXRC-TS</td>            </tr>            <tr>                <td>import_33_service (experimental)</td>                <td>9%</td>                <td></td>                <td>TXRC-ESS</td>            </tr>            <tr>                <td>import_n33_service (experimental)</td>                <td>9%</td>                <td></td>                <td>TXRC-N33</td>            </tr>            <tr>                <td>import_reverse_charge_service (experimental)</td>                <td>9%</td>                <td></td>                <td>TXRC-RE</td>            </tr>            <tr>                <td>import_goods (experimental)</td>                <td>9%</td>                <td></td>                <td>IM</td>            </tr>            <tr>                <td>import_33_goods (experimental)</td>                <td>9%</td>                <td></td>                <td>IM-ESS</td>            </tr>            <tr>                <td>import_n33_goods (experimental)</td>                <td>9%</td>                <td></td>                <td>IM-N33</td>            </tr>            <tr>                <td>import_reverse_charge_goods (experimental)</td>                <td>9%</td>                <td></td>                <td>IM-RE</td>            </tr>            <tr>                <td>import_mes (experimental)</td>                <td>9%</td>                <td></td>                <td>ME</td>            </tr>            <tr>                <td>import_gst_ds (experimental)</td>                <td>9%</td>                <td></td>                <td>IGDS</td>            </tr>            <tr>                <td>blocked (experimental)</td>                <td>9%</td>                <td></td>                <td>BL</td>            </tr>            <tr>                <td>exempt_purchase (experimental)</td>                <td>0%</td>                <td></td>                <td>EP</td>            </tr>        </table>    </li>    <li>        US:        <ul>            <li>standard (any percentage)</li>            <li>exempt (0%)</li>            <li>export (0%)</li>            <li>outside_scope (0%)</li>        </ul>    </li></ul>\n++++","type":"string","enum":["standard","zero_rated","reverse_charge","intra_community","exempt","export","outside_scope","regulation33_exempt","nonregulation33_exempt","deemed_supply","srca_s","srca_c","not_registered","igst","cgst","sgst","cess","state_cess","srovr","srovr_rs","srovr_lvg","srlvg","bollo_virtuale","exempt_it_n1","sales","service","tourism","high_value_goods","low_value_goods","sales_zero","service_zero","not_applicable","standard_ca","standard_na","standard_re","standard_n33","standard_33","import_service","import_33_service","import_n33_service","import_reverse_charge_service","import_goods","import_33_goods","import_n33_goods","import_reverse_charge_goods","import_mes","import_gst_ds","blocked","exempt_purchase","standard_additional","ieps","wht"]},"type":{"title":"Tax Type","description":"The type of tax. This field is only used for receiving. For sending, the type is automatically determined from the country code and should not be supplied.","type":"string","enum":["VAT","GST"]}},"required":["country"]},"TaxSubtotal":{"title":"Tax Subtotal","description":"The total amount of tax of this type in the invoice.","type":"object","properties":{"taxableAmount":{"title":"Taxable Amount","description":"The amount on which the tax is levied.","type":"number"},"taxAmount":{"title":"The amount of tax levied","description":"The amount of tax.","type":"number"},"percentage":{"title":"Percentage Tax","description":"The tax percentage. This should be a valid tax percentage in the country at the time of the taxpointDate of this invoice.","type":"number"},"category":{"title":"Tax category","description":"The tax category. For a description see <<_openapi_tax>>","type":"string","enum":["standard","zero_rated","reverse_charge","intra_community","exempt","export","outside_scope","regulation33_exempt","nonregulation33_exempt","deemed_supply","srca_s","srca_c","not_registered","igst","cgst","sgst","cess","state_cess","srovr","srovr_rs","srovr_lvg","srlvg","bollo_virtuale","exempt_it_n1","sales","service","tourism","high_value_goods","low_value_goods","sales_zero","service_zero","not_applicable","standard_ca","standard_na","standard_re","standard_n33","standard_33","import_service","import_33_service","import_n33_service","import_reverse_charge_service","import_goods","import_33_goods","import_n33_goods","import_reverse_charge_goods","import_mes","import_gst_ds","blocked","exempt_purchase","standard_additional","ieps","wht"]},"country":{"$ref":"#/definitions/Country","description":"The country levying the tax."},"taxExemptionReasonCode":{"title":"Tax Exemption Reason Code","description":"The VAT exemption reason code for this tax subtotal. For Peppol BIS Billing 3.0 this should be a valid VATEX code.","type":"string"},"taxExemptionReason":{"title":"Tax Exemption Reason","description":"The VAT exemption reason text for this tax subtotal.","type":"string"}},"required":["taxAmount","country"]},"TaxAuthority":{"title":"Tax Authority","description":"Information relating to a tax authority.","type":"object","properties":{"uuid":{"title":"UUID","description":"The uuid assigned by the tax authority upon validation.","type":"string","minLength":3},"uri":{"title":"URI","description":"A URI (deep link) to the document with the tax authority.","type":"string","minLength":3},"validatedAt":{"title":"Validated At","description":"The datetime when the document was validated by the tax authority.","type":"string","minLength":3}}}}}