storecove
Module storecove
API
Definitions
ballerinax/storecove Ballerina library
Overview
Storecove is a document exchange platform that sends and receives electronic business documents, such as invoices and credit notes, over networks like Peppol on behalf of its customers. It handles legal entity registration, recipient discovery, document submission with delivery evidence, and the retrieval of documents received from trading partners.
The Storecove connector lets Ballerina applications call the Storecove API, version 2.0.1, to manage legal entities and their identifiers, discover trading partners on the network, submit documents and track their delivery, and fetch received documents and purchase invoices.
Key features
- Register and manage legal entities, their Peppol identifiers and additional tax identifiers
- Discover whether trading partners exist on the network and which documents they can receive
- Submit invoices and other documents and retrieve their delivery evidence
- Retrieve received documents and purchase invoices in JSON or the original format
Setup guide
To use the Storecove connector, you need a Storecove account and an API key.
-
Sign in to your Storecove account or request access from Storecove if you do not have one.
-
Open the API settings of your account and create an API key.
-
Copy the key and keep it secure. The connector sends it as a bearer token in the
Authorizationheader (Authorization: Bearer <API_KEY>) of every request.
Quickstart
To use the Storecove connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
import ballerinax/storecove;
Step 2: Instantiate a new connector
Create a Config.toml file with your API key.
apiKey = "<API_KEY>"
Then create a storecove:Client using the configured key as a bearer token.
configurable string apiKey = ?; final storecove:Client storecoveClient = check new ({auth: {token: apiKey}});
Step 3: Invoke the connector operation
Retrieve the identifier specifications that Storecove supports for each country.
public function main() returns error? { storecove:CountrySpecifications _ = check storecoveClient->discoverIdentifiers(); }
Step 4: Run the Ballerina application
bal run
Examples
The Storecove connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Legal entity onboarding - Create a legal entity, register its Peppol and additional tax identifiers, and read it back.
- Peppol recipient discovery - Check whether a recipient exists on the Peppol network and which document types it can receive.
Clients
storecove: Client
Storecove API
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.storecove.com/api/v2" - URL of the target service
createAdditionalTaxIdentifier
function createAdditionalTaxIdentifier(int legalEntityId, AdditionalTaxIdentifierCreate payload, map<string|string[]> headers) returns AdditionalTaxIdentifier|errorCreate a new AdditionalTaxIdentifier
Parameters
- legalEntityId int - The id of the LegalEntity for which to create the AdditionalTaxIdentifier
- payload AdditionalTaxIdentifierCreate - AdditionalTaxIdentifier to create
Return Type
- AdditionalTaxIdentifier|error - Unauthorized
getAdditionalTaxIdentifier
function getAdditionalTaxIdentifier(int legalEntityId, int id, map<string|string[]> headers) returns AdditionalTaxIdentifier|errorGet AdditionalTaxIdentifier
Parameters
- legalEntityId int - The id of the LegalEntity the AdditionalTaxIdentifier belongs to
- id int - The id of the AdditionalTaxIdentifier
Return Type
- AdditionalTaxIdentifier|error - Unauthorized
deleteAdditionalTaxIdentifier
function deleteAdditionalTaxIdentifier(int legalEntityId, int id, map<string|string[]> headers) returns error?Delete AdditionalTaxIdentifier
Parameters
- legalEntityId int - The id of the LegalEntity the AdditionalTaxIdentifier belongs to
- id int - The id of the AdditionalTaxIdentifier
Return Type
- error? - Unauthorized
updateAdditionalTaxIdentifier
function updateAdditionalTaxIdentifier(int legalEntityId, int id, AdditionalTaxIdentifierUpdate payload, map<string|string[]> headers) returns AdditionalTaxIdentifier|errorUpdate AdditionalTaxIdentifier
Parameters
- legalEntityId int - The id of the LegalEntity the AdditionalTaxIdentifier belongs to
- id int - The id of the AdditionalTaxIdentifier to be updated
- payload AdditionalTaxIdentifierUpdate - AdditionalTaxIdentifier to update
Return Type
- AdditionalTaxIdentifier|error - Unauthorized
createAdministration
function createAdministration(int legalEntityId, AdministrationCreate payload, map<string|string[]> headers) returns Administration|errorDEPRECATED. Create a new Administration
Parameters
- legalEntityId int - The id of the LegalEntity for which to create the Administration
- payload AdministrationCreate - Administration to create
Return Type
- Administration|error - Unauthorized
getAdministration
function getAdministration(int legalEntityId, int id, map<string|string[]> headers) returns Administration|errorDEPRECATED. Get Administration
Parameters
- legalEntityId int - The id of the LegalEntity the Administration belongs to
- id int - The id of the Administration
Return Type
- Administration|error - Unauthorized
deleteAdministration
function deleteAdministration(int legalEntityId, int id, map<string|string[]> headers) returns error?DEPRECATED. Delete Administration
Parameters
- legalEntityId int - The id of the LegalEntity the Administration belongs to
- id int - The id of the Administration
Return Type
- error? - Unauthorized
updateAdministration
function updateAdministration(int legalEntityId, int id, AdministrationUpdate payload, map<string|string[]> headers) returns Administration|errorDEPRECATED. Update Administration
Parameters
- legalEntityId int - The id of the LegalEntity the Administration belongs to
- id int - The id of the Administration to be updated
- payload AdministrationUpdate - Administration to update
Return Type
- Administration|error - Unauthorized
createC5Activation
function createC5Activation(int legalEntityId, C5ActivationRequest payload, map<string|string[]> headers) returns C5ActivationResponse|errorDEPRECATED. Request a new C5 Activation
Parameters
- legalEntityId int - The id of the LegalEntity for which to create the C5ActivationRequest
- payload C5ActivationRequest - The C5ActivationRequest to initiate
Return Type
- C5ActivationResponse|error - Unauthorized
createC5Deactivation
function createC5Deactivation(int legalEntityId, C5DeactivationRequest payload, map<string|string[]> headers) returns C5DeactivationResponse|errorDEPRECATED. Request a new C5 Deactivation
Parameters
- legalEntityId int - The id of the LegalEntity for which to create the C5DeactivationRequest
- payload C5DeactivationRequest - The C5DeactivationRequest to initiate
Return Type
- C5DeactivationResponse|error - Unauthorized
activateC5Email
function activateC5Email(int legalEntityId, C5EmailRequest payload, map<string|string[]> headers) returns error?Request a new C5 Email Activation
Parameters
- legalEntityId int - The id of the LegalEntity for which to create the C5EmailRequest
- payload C5EmailRequest - The C5EmailRequest to initiate
Return Type
- error? - Unauthorized
deactivateC5Email
function deactivateC5Email(int legalEntityId, C5EmailRequest payload, map<string|string[]> headers) returns error?Request a new C5 Email Deactivation
Parameters
- legalEntityId int - The id of the LegalEntity for which to create the C5EmailRequest
- payload C5EmailRequest - The C5EmailRequest to initiate
Return Type
- error? - Unauthorized
cancelC5Email
function cancelC5Email(string legalEntityId, C5EmailCancellationRequest payload, map<string|string[]> headers) returns error?Cancel a C5 email activation or deactivation
Parameters
- legalEntityId string - Legal entity ID
- payload C5EmailCancellationRequest - The C5EmailCancellationRequest to cancel
Return Type
- error? - If cancellation of a initiated C5 activation / C5 deactivation is successful
activateC5Redirect
function activateC5Redirect(int legalEntityId, C5RedirectRequest payload, map<string|string[]> headers) returns C5RedirectResponse|errorRequest a new C5 Redirect Activation
Parameters
- legalEntityId int - The id of the LegalEntity for which to create the C5RedirectRequest
- payload C5RedirectRequest - The C5RedirectRequest to initiate
Return Type
- C5RedirectResponse|error - Unauthorized
deactivateC5Redirect
function deactivateC5Redirect(int legalEntityId, C5RedirectRequest payload, map<string|string[]> headers) returns C5RedirectResponse|errorRequest a new C5 Redirect Deactivation
Parameters
- legalEntityId int - The id of the LegalEntity for which to create the C5RedirectRequest
- payload C5RedirectRequest - The C5RedirectRequest to initiate
Return Type
- C5RedirectResponse|error - Unauthorized
cancelC5Redirect
function cancelC5Redirect(string legalEntityId, C5RedirectCancellationRequest payload, map<string|string[]> headers) returns error?Cancel a C5 redirect activation or deactivation
Parameters
- legalEntityId string - Legal entity ID
- payload C5RedirectCancellationRequest - The C5RedirectCancellationRequest to cancel
Return Type
- error? - If cancellation of a initiated C5 activation / C5 deactivation is successful
discoverReceives
function discoverReceives(DiscoverableParticipant payload, map<string|string[]> headers) returns DiscoveredParticipant|errorDiscover Network Participant Capabilites
Parameters
- payload DiscoverableParticipant - The participant to check
Return Type
- DiscoveredParticipant|error - The discovered network participant
discoverExists
function discoverExists(DiscoverableParticipant payload, map<string|string[]> headers) returns DiscoveredParticipant|errorDiscover Network Participant Existence
Parameters
- payload DiscoverableParticipant - The participant to check
Return Type
- DiscoveredParticipant|error - The discovered network participant
discoverIdentifiers
function discoverIdentifiers(map<string|string[]> headers) returns CountrySpecifications|errorDiscover Country Identifiers ** EXPERIMENTAL
Return Type
- CountrySpecifications|error - The identifiers used in each country
getInvoiceSubmissionEvidence
function getInvoiceSubmissionEvidence(string guid, map<string|string[]> headers) returns InvoiceSubmissionEvidence|errorDEPRECATED. Get InvoiceSubmission Evidence
Parameters
- guid string - InvoiceSubmission GUID
Return Type
- InvoiceSubmissionEvidence|error - Unauthorized
createInvoiceSubmission
function createInvoiceSubmission(InvoiceSubmission payload, map<string|string[]> headers) returns InvoiceSubmissionResult|errorDEPRECATED. Submit a new invoice
Parameters
- payload InvoiceSubmission - Invoice to submit
Return Type
- InvoiceSubmissionResult|error - Unauthorized
createDocumentSubmission
function createDocumentSubmission(DocumentSubmission payload, map<string|string[]> headers) returns DocumentSubmissionResult|errorSubmit a new document.
Parameters
- payload DocumentSubmission - Document to submit
Return Type
- DocumentSubmissionResult|error - Unauthorized
getDocumentSubmissionEvidence
function getDocumentSubmissionEvidence(string guid, "sending"|"clearing" evidenceType, map<string|string[]> headers) returns DocumentSubmissionEvidence|errorGet DocumentSubmission Evidence
Parameters
- guid string - DocumentSubmission GUID
- evidenceType "sending"|"clearing" - Type of evidence requested
Return Type
- DocumentSubmissionEvidence|error - Unauthorized
preflightInvoiceRecipient
function preflightInvoiceRecipient(InvoiceRecipientPreflight payload, map<string|string[]> headers) returns PreflightInvoiceRecipientResult|errorDEPRECATED. Preflight an invoice recipient
Parameters
- payload InvoiceRecipientPreflight - The invoice recipient to preflight
Return Type
- PreflightInvoiceRecipientResult|error - Unauthorized
createLegalEntity
function createLegalEntity(LegalEntityCreate payload, map<string|string[]> headers) returns LegalEntity|errorCreate a new LegalEntity
Parameters
- payload LegalEntityCreate - LegalEntity to create
Return Type
- LegalEntity|error - Unauthorized
getLegalEntity
Get LegalEntity
Parameters
- id int - legal_entity id
Return Type
- LegalEntity|error - Unauthorized
deleteLegalEntity
Delete LegalEntity
Parameters
- id int - legal_entity id
Return Type
- error? - Unauthorized
updateLegalEntity
function updateLegalEntity(int id, LegalEntityUpdate payload, map<string|string[]> headers) returns LegalEntity|errorUpdate LegalEntity
Return Type
- LegalEntity|error - Unauthorized
getPurchaseInvoice
function getPurchaseInvoice(string guid, map<string|string[]> headers, *GetPurchaseInvoiceQueries queries) returns PurchaseInvoice|errorDEPRECATED. Get Purchase invoice data as JSON
Parameters
- guid string - The guid of the purchase invoice, from the webhook
- queries *GetPurchaseInvoiceQueries - Queries to be sent with the request
Return Type
- PurchaseInvoice|error - Unauthorized
getPurchaseInvoicePackaged
function getPurchaseInvoicePackaged(string guid, "json"|"ubl"|"original" packaging, map<string|string[]> headers, *GetPurchaseInvoicePackagedQueries queries) returns PurchaseInvoiceUbl|errorDEPRECATED. Get Purchase invoice data in a selectable format
Parameters
- guid string - purchase invoice guid
- packaging "json"|"ubl"|"original" - How to package the purchase invoice. Note that "ubl" is deprecated
- queries *GetPurchaseInvoicePackagedQueries - Queries to be sent with the request
Return Type
- PurchaseInvoiceUbl|error - Unauthorized
getPurchaseInvoiceVersioned
function getPurchaseInvoiceVersioned(string guid, "ubl" packaging, "si11"|"si12"|"si20"|"aunz"|"sg"|"jp"|"en16931"|"original" packageVersion, map<string|string[]> headers) returns PurchaseInvoiceUbl|errorDEPRECATED. Get Purchase invoice data as JSON with a Base64-encoded UBL string in the specified version
Parameters
- guid string - purchase invoice guid
- packaging "ubl" - How to package the purchase invoice
- packageVersion "si11"|"si12"|"si20"|"aunz"|"sg"|"jp"|"en16931"|"original" - The version of the package
Return Type
- PurchaseInvoiceUbl|error - Unauthorized
createPeppolIdentifier
function createPeppolIdentifier(int legalEntityId, PeppolIdentifierCreate payload, map<string|string[]> headers) returns PeppolIdentifier|errorCreate a new PeppolIdentifier
Parameters
- legalEntityId int - The id of the LegalEntity for which to create the PeppolIdentifier
- payload PeppolIdentifierCreate - PeppolIdentifier to create
Return Type
- PeppolIdentifier|error - Unauthorized
deletePeppolIdentifier
function deletePeppolIdentifier(int legalEntityId, string superscheme, string scheme, string identifier, map<string|string[]> headers) returns error?Delete PeppolIdentifier
Parameters
- legalEntityId int - The id of the LegalEntity this PeppolIdentifier belongs to
- superscheme string - The superscheme of the identifier. Should always be "iso6523-actorid-upis"
- scheme string - PEPPOL identifier scheme id, e.g. "DE:VAT". For a full list see <<_receiver_identifiers_list>>
- identifier string - PEPPOL identifier
Return Type
- error? - Unauthorized
updatePeppolIdentifier
function updatePeppolIdentifier(int legalEntityId, string superscheme, string scheme, string identifier, PeppolIdentifierAnnuaireUpdate payload, map<string|string[]> headers) returns PeppolIdentifier|errorUpdate a PeppolIdentifier
Parameters
- legalEntityId int - The id of the LegalEntity this PeppolIdentifier belongs to
- superscheme string - The superscheme of the identifier. Should always be "iso6523-actorid-upis"
- scheme string - PEPPOL identifier scheme id, e.g. "FR:CTC". For a full list see <<_receiver_identifiers_list>>
- identifier string - PEPPOL identifier
- payload PeppolIdentifierAnnuaireUpdate - The annuaire data to update
Return Type
- PeppolIdentifier|error - Unauthorized
createReceivedDocument
function createReceivedDocument(int legalEntityId, ReceivedDocumentCreate payload, map<string|string[]> headers) returns ReceivedDocument|errorReceive a new Document
Parameters
- legalEntityId int - The id of the LegalEntity for which the document was received
- payload ReceivedDocumentCreate - Received document to process
Return Type
- ReceivedDocument|error - Unauthorized
getReceivedDocument
function getReceivedDocument(string guid, "json"|"original" format, map<string|string[]> headers, *GetReceivedDocumentQueries queries) returns Transportable|errorGet a new ReceivedDocument
Parameters
- guid string - The guid of the document that was received. This is the "document_guid" property of the "received_document" webhook
- format "json"|"original" - The format in which to receive the received document
- queries *GetReceivedDocumentQueries - Queries to be sent with the request
Return Type
- Transportable|error - Unauthorized
getWebhookInstance
function getWebhookInstance(map<string|string[]> headers) returns WebhookInstance|error?GET a WebhookInstance
Return Type
- WebhookInstance|error? - Unauthorized
deleteWebhookInstance
DELETE a WebhookInstance
Parameters
- guid string - WebhookInstance guid
Return Type
- error? - Unauthorized
Records
storecove: AccountingCustomerParty
The customer receiving the document
Fields
- publicIdentifiers? PublicIdentifier[] - A list of legal and tax identifiers for this customer
- party Party - A party that can receive or send invoices
storecove: AccountingSupplierParty
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
Fields
- publicIdentifiers? PublicIdentifier[] - A list of legal and tax identifiers for this supplier
- party? Party - A party that can receive or send invoices
storecove: AdditionalItemProperty
An additional property for the item. Two valid forms: (a) textual — both name and value must be present; (b) coded measurement (FR-FE EXT-FR-FE-159/160/161) — all of nameCode, valueQuantity and valueQuantityUnitCode must be present. Cross-form validation is enforced by InvoiceSubmissionValidationService because our JSON Schema dialect does not support anyOf/allOf
Fields
- nameCode? string - Coded identifier for the property (FR-FE EXT-FR-FE-159). Must be a UN/EDIFACT 6313 code (https://service.unece.org/trade/untdid/d00a/tred/tred6313.htm). Maps to UBL AdditionalItemProperty/NameCode and CII ApplicableProductCharacteristic/TypeCode
- name? string - The free-text name of the property. Maps to UBL AdditionalItemProperty/Name and CII ApplicableProductCharacteristic/Description
- valueQuantityUnitCode? string - Unit of measure for
valueQuantity(FR-FE EXT-FR-FE-161). Maps to UBL AdditionalItemProperty/ValueQuantity@unitCode and CII ApplicableProductCharacteristic/ValueMeasure@unitCode
- value? string - The free-text value of the property. Maps to UBL AdditionalItemProperty/Value and CII ApplicableProductCharacteristic/Value
- valueQuantity? string - Numeric value of the measured property (FR-FE EXT-FR-FE-160). Maps to UBL AdditionalItemProperty/ValueQuantity and CII ApplicableProductCharacteristic/ValueMeasure
storecove: AdditionalTaxIdentifier
Fields
- country? string - The ISO3166 country code to use this identifier for in case of consumerTaxMode
- identifier? string - The identifier
- scheme? string - The scheme of the identifier
- county? string - The county/state inside the country code to use this identifier for in case of consumerTaxMode
- id? int - The Storecove assigned id for the AdditionalTaxIdentifier
- superscheme? string - The superscheme of the identifier
storecove: AdditionalTaxIdentifierCreate
Fields
- country string - The ISO3166 country code to use this identifier for in case of consumerTaxMode
- identifier string - The identifier
- thirdPartyPassword? string - 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
- scheme string - The scheme of the identifier
- county? string - 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)
- thirdPartyUsername? string - 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
- superscheme string - The superscheme of the identifier. Should always be "iso6523-actorid-upis"
storecove: AdditionalTaxIdentifierUpdate
Fields
- identifier string - The identifier
- thirdPartyPassword? string - 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
- thirdPartyUsername? string - 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
storecove: Address
The address
Fields
- zip? string - The zipcode/postalzone. Mandatory unless the country does not have zip codes
- country Country - An ISO 3166-1 alpha-2 country code
- city? string - The name of the city. Mandatory in most countries
- county? string - An optional county name
- street1? string - The street name and number. Mandatory in most countries
- street2? string - The second street field. Use this if you used the first field for the building name
storecove: Administration
Fields
- senderEmailIdentityId? int - The id of the SenderEmailIdentity. If not provided, the Storecove default sender will be used
- legalEntityId? int - The LegalEntity the Administration belongs to
- packageVersion? "peppol_bis_v3"|"aunz"|"sg" - The version of the package
- packaging? "ubl" - How to package the purchase invoice
- id? int - The Storecove assigned id for the Administration
- email? string - The email address to send the received document to
storecove: AdministrationCreate
Fields
- senderEmailIdentityId? int - The id of the SenderEmailIdentity. If not provided, the Storecove default sender will be used
- legalEntityId? int - The LegalEntity the Administration belongs to
- packageVersion "peppol_bis_v3"|"aunz"|"sg" (default "peppol_bis_v3") - The version of the package
- packaging "ubl" (default "ubl") - How to package the purchase invoice
- email? string - The email address to send the received document to
storecove: AdministrationUpdate
Fields
- senderEmailIdentityId? int - The id of the SenderEmailIdentity. If not provided, the Storecove default sender will be used
- packageVersion? "peppol_bis_v3"|"aunz"|"sg" - The version of the package
- packaging? "ubl" - How to package the purchase invoice
- email? string - The email address to send the received document to
storecove: AETransactionType
The UAE invoice transaction type (BTAE-02). Only used when the sender country is AE (PINT-AE). Each flag marks whether the corresponding transaction characteristic applies to the document. All flags default to false. Maps to UBL ProfileExecutionID as an 8-character string of 0/1 flags in the order: free trade zone, deemed supply, margin scheme, summary invoice, continuous supply, disclosed agent billing, e-commerce, exports. See <<country_ae>>
Fields
- eCommerce boolean(default false) - The supply is made through e-commerce
- disclosedAgentBilling boolean(default false) - The document is issued by a disclosed agent on behalf of a principal. When true, the principal must be identified through a publicIdentifier of the accountingSupplierParty (on the LegalEntity)
- marginScheme boolean(default false) - The supply falls under the profit margin scheme
- summaryInvoice boolean(default false) - The document is a summary invoice. When true, provide the billingFrequency and the invoicePeriod
- exports boolean(default false) - The supply is an export outside the UAE
- freeTradeZone boolean(default false) - The supply involves a free trade zone. When true, the beneficiary must be identified through a publicIdentifier of the accountingCustomerParty
- continuousSupply boolean(default false) - The supply is a continuous supply
- deemedSupply boolean(default false) - The supply is a deemed supply
storecove: AllowanceCharge
Fields
- amountExcludingVat? decimal - DEPRECATED. Use amountExcludingTax. The amount for the allowance or charge, excluding VAT
- reason? string - The reason for the allowance or charge, free text. Defaults to 'Mutually Agreed' if neither reason nor reasonCode are provided
- taxExemptionReasonCode? string - Coded reason (VATEX code) explaining why the tax on this allowance or charge is exempt or zero-rated. Used for the French e-invoicing reform (FR-FE EXT-FR-FE-188/190). Maps to UBL AllowanceCharge/TaxCategory/TaxExemptionReasonCode and CII SpecifiedTradeAllowanceCharge/CategoryTradeTax/ExemptionReasonCode
- amountExcludingTax? decimal - The amount for the allowance or charge, excluding tax
- baseAmountIncludingTax? decimal - The base amount for the allowance or charge, including tax
- tax? Tax -
- taxExemptionReason? string - Free-text reason explaining why the tax on this allowance or charge is exempt or zero-rated. Used for the French e-invoicing reform (FR-FE EXT-FR-FE-187/189). Maps to UBL AllowanceCharge/TaxCategory/TaxExemptionReason and CII SpecifiedTradeAllowanceCharge/CategoryTradeTax/ExemptionReason
- taxesDutiesFees? Tax[] - 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
- reasonCode? string - The reason code for the allowance or charge
- baseAmountExcludingTax? decimal - The base amount for the allowance or charge, excluding tax
- amountIncludingTax? decimal - The amount for the allowance or charge, including tax
storecove: Attachment
A document attachment to the invoice
Fields
- filename? string - The name of the file attachment
- primaryImage boolean(default false) - 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
- document string - The base64 encoded version of the document attachment
- description? string - A description for the file attachment
- documentId? string - An id for the file attachment
- mimeType "text/csv"|"application/pdf"|"image/png"|"image/jpeg"|"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"|"application/vnd.oasis.opendocument.spreadsheet" - The document attachment mime type
storecove: BusinessReceiver
The business receiver of the document
Fields
- routing? CountrySpecificationIdentifier -
- legal? CountrySpecificationIdentifier -
storecove: BuyerAgentParty
An agent acting on behalf of the buyer. Used in the French e-invoicing reform (FR-FE EXT-FR-FE-BG-01). Maps to UBL AccountingCustomerParty/Party/AgentParty and CII BuyerAgentTradeParty
Fields
- publicIdentifiers? PublicIdentifier[] - A list of legal and tax identifiers for this party
- party Party - A party that can receive or send invoices
storecove: BuyerCustomerPartyOrder
The buyer sending the order
Fields
- party SenderParty - A party that can send documents
storecove: C5ActivationRequest
The C5 activation request
Fields
- clientRedirectSuccessUrl string - The URL to redirect to in case of a C5 authorization success
- identifier string - The identifier
- flowType "flow_redirect" - The flow type
- scheme "SG:UEN" - The scheme
- clientRedirectFailUrl string - The URL to redirect to in case of a C5 authorization fail
- superscheme "iso6523-actorid-upis" - The superscheme of the identifier. Should always be 'iso6523-actorid-upis'
- simulate boolean - Whether to simulate the C5 activation
storecove: C5ActivationResponse
The response to a C5 activation request
Fields
- redirectUrl string - The URL to redirect to
storecove: C5DeactivationRequest
The C5 deactivation request
Fields
- clientRedirectSuccessUrl string - The URL to redirect to in case of a C5 authorization success
- identifier string - The identifier
- flowType "flow_redirect" - The flow type
- scheme "SG:UEN" - The scheme
- clientRedirectFailUrl string - The URL to redirect to in case of a C5 authorization fail
- superscheme "iso6523-actorid-upis" - The superscheme of the identifier. Should always be 'iso6523-actorid-upis'
- simulate boolean - Whether to simulate the C5 deactivation
storecove: C5DeactivationResponse
The response to a C5 deactivation request
Fields
- redirectUrl string - The URL to redirect to
storecove: C5EmailCancellationRequest
The C5 email cancellation request object
Fields
- identifier string - The identifier
- scheme "SG:UEN" - The scheme
- superscheme "iso6523-actorid-upis" - The superscheme
storecove: C5EmailRequest
The C5 email request object for both activation and deactivation
Fields
- identifier string - The identifier
- scheme "SG:UEN" - The scheme
- name string - Name of the signer
- superscheme "iso6523-actorid-upis" - The superscheme
- email string - Email of the signer
storecove: C5RedirectCancellationRequest
The C5 redirect cancellation request object
Fields
- identifier string - The identifier
- scheme "SG:UEN" - The scheme
- superscheme "iso6523-actorid-upis" - The superscheme
storecove: C5RedirectRequest
The C5 redirect request object for both activation and deactivation
Fields
- clientRedirectSuccessUrl string - The URL to redirect to in case of a C5 authorization success
- identifier string - The identifier
- scheme "SG:UEN" - The scheme
- clientRedirectFailUrl string - The URL to redirect to in case of a C5 authorization fail
- name? string - The representative name. Required by Dex when it is not stored on the Peppol identifier
- superscheme "iso6523-actorid-upis" - The superscheme
- simulate? boolean - Whether to simulate the C5 request
- email? string - The representative email. Required by Dex when it is not stored on the Peppol identifier
storecove: C5RedirectResponse
The response to a C5 redirect request
Fields
- redirectUrl string - The URL to redirect to
storecove: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
storecove: ConsumerReceiver
The consumer receiver of the document
Fields
- routing? CountrySpecificationIdentifier -
- legal? CountrySpecificationIdentifier -
storecove: Contact
Contact details for the invoice
Fields
- firstName? string -
- lastName? string -
- phone? string -
- id? string - Only supported for AccountingCustomerParty
- email? string -
storecove: CorpPass
Fields
- signerName? string - The name of the person who is going to perform the CorpPass process
- clientRedirectSuccessUrl? string - The URL the CorpPass system will redirect to in case of successful identity verfication
- flowType? "corppass_flow_redirect"|"corppass_flow_email"|"corppass_flow_pdf" - The CorpPass flow type
- simulateCorppass boolean(default false) - Whether or not CorpPass is being simulated
- clientRedirectFailUrl? string - The URL the CorpPass system will redirect to in case of a failure to perform identity verfication
- corppassUrl? string - The CorpPass redirect URL
- signerEmail? string - The email of the person who is going to perform the CorpPass process
- enabled boolean(default false) - Whether or not the CorpPass flow is enabled
- status? "corppass_no_status"|"corppass_initiated"|"corppass_cancelled"|"corppass_failed"|"corppass_succeeded" - The status of the CorpPass process
storecove: CorpPassCreate
Fields
- signerName? string - The name of the person who is going to perform the CorpPass process. Mandatory for flow_type="corppass_flow_email" and for redirect KYC on Dex
- clientRedirectSuccessUrl? string - The URL the CorpPass system will redirect to in case of successful identity verfication. Mandatory for flow_type="corppass_flow_redirect"
- flowType "corppass_flow_redirect"|"corppass_flow_email"|"corppass_flow_pdf" - The CorpPass flow type. Note that using corppass_flow_pdf requires special setup of your account by Storecove
- kycDocument? string - The Base64-encoded PDF document used for KYC. Mandatory for flow_type="corppass_flow_pdf"
- simulateCorppass boolean(default false) - 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
- clientRedirectFailUrl? string - The URL the CorpPass system will redirect to in case of a failure to perform identity verfication. Mandatory for flow_type="corppass_flow_redirect"
- signerEmail? string - The email of the person who is going to perform the CorpPass process. Mandatory for flow_type="corppass_flow_email" and for redirect KYC on Dex
- enabled boolean(default true) - DEPRECATED. Whether or not to enable the CorpPass flow. Must be true if provided
storecove: CountrySpecification
Fields
- country? Country - An ISO 3166-1 alpha-2 country code
- receiver? Receiver - The receiver of the document
- sender? Sender - The sender of the document
- region? "eu_eea"|"sg"|"aunz"|"in"|"world" - 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
storecove: CountrySpecificationIdentifier
Fields
- scheme? string - The scheme of the identifier
- schemeNumercial? string - The numerical version of the scheme of the identifier
- description? string - Identifier description
- centralizedIdentifier? string - The centralized identifier to use for routing, if the "centralized" proprerty is true
- centalizedIdentifierTest? string - 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
- schemeType? "iso6523-actorid-upis" - The scheme type of the identifier. Currently always "iso6523-actorid-upis"
- centralized? boolean - 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
storecove: CountrySpecifications
Fields
- countries? CountrySpecification[] -
storecove: Delivery
Fields
- actualDeliveryDate? string - The actual date of the delivery. Used only for Invoice
- quantity? decimal - The quantity of the delivery. Used only for Invoice
- shipment? Shipment -
- deliveryLocation? DeliveryDeliveryLocation -
- deliveryParty? DeliveryParty - The party receiving the shipment
- shippingMarks? string - DEPRECATED. Use the shipment object. A text that the buyer requests to be printed on the packing labels. Used only for DocumentOrder
- requestedDeliveryPeriod? string - 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
- deliveryPartyName? string - DEPRECATED. Use deliveryParty. The name of the party that took delivery. Used only for Invoice
storecove: DeliveryDeliveryLocation
Fields
- locationName? string - The name of the delivery location. Only used for DocumentOrder
- address? Address - The address
- schemeAgencyId? string - DEPRECATED. The schemeAgencyId of the location identifier (e.g. 'ZZZ')
- schemeId? string - The schemeId of the location identifier (e.g. 'EAN')
- id? string - The location identifier
storecove: DeliveryParty
The party receiving the shipment
Fields
- publicIdentifiers? PublicIdentifier[] - A list of legal and tax identifiers for this delivery party
- party ReceiverParty - A party that can receive or send invoices
storecove: DeliveryTerms
Fields
- specialTerms? string - A description of special conditions relating to the delivery terms
- incoterms? "EXW"|"FCA"|"CPT"|"CIP"|"DAP"|"DPU"|"DDP"|"FAS"|"FOB"|"CFR"|"CIF" - The incoterms:
- deliveryLocationId? string - The location to which the delivery terms refer
storecove: DgfipAnnuaire
Fields
- routingCodeLabel? string - Human-readable label for the routing code (annuaire central libelleCodeRoutage). Mandatory when the identifier carries a routing code
- address? DgfipAnnuaireAddress -
- startDate? string - Planned start date (dateDebutEffet) for the annuaire line. Defaults to today + 1 day (annuaire central rule G1.87)
storecove: DgfipAnnuaireAddress
Fields
- zip? string - The zipcode
- country? string - ISO 3166-1 alpha-2 country code
- city? string - The city
- street1? string - The first address line
- street2? string - The second address line, if applicable
storecove: DgfipAnnuaireUpdate
Fields
- routingCodeLabel? string - Human-readable label for the routing code (annuaire central libelleCodeRoutage). Mandatory when the identifier carries a routing code
- address? DgfipAnnuaireAddress -
storecove: DiscoverableParticipant
A participant to be discovered
Fields
- identifier string - The actual identifier
- scheme string - The scheme of the identifier. See <<_receiver_identifiers_list>> for a list
- metaScheme string(default "iso6523-actorid-upis") - The meta scheme of the identifier. For Peppol this is always 'iso6523-actorid-upis'
- documentTypes? ("invoice"|"creditnote"|"invoice_response"|"order"|"ordering"|"order_response")[] - An array of document types to discover. The default is '["invoice", "creditnote"]'. This is ignored when only checking existence
- flags? DiscoveryFlag - A flag to filter for documents
- network string(default "peppol") - The network to check. Currently only 'peppol' is supported
storecove: DiscoveredParticipant
A public identifier for this customer
Fields
- code? "OK"|"NOK" - The response code
- email? boolean - 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^]
storecove: DiscoveryFlag
A flag to filter for documents
Fields
- supportsSelfBilling "allowed"|"required"|"not_allowed" (default "not_allowed") - Whether or not to filter for documents that support self billing
storecove: DocumentInvoiceReport
The invoice report to send. Reports a received invoice (forDocumentGuid) to the tax authority as a purchase, reusing the data of the received invoice.
Fields
- action string - The action to take
storecove: DocumentInvoiceResponse
The invoice response to send or received
Fields
- note? string - A note to add to the invoice reponse
- clarifications? InvoiceResponseClarification[] - A list of clarifications why a received invoice was rejected (RE), under query (UQ) or partially approved (CA), and what action to take. For responses CA, UQ and RE, at least one clarification with a clarificationCode is required. For invoices received through the French (fr-dgfip) workflow, at least one of them must have clarificationCodeType OPStatusReason
- id? string - The identifier of the Invoice Response / ApplicationResponse document (UBL cbc:ID). Present on received responses in document_submission webhooks (acknowledged, in_process, and later buyer statuses). Not required when you send an invoice response
- effectiveDate? string - The date when the status became effective. Format: yyyy-mm-dd
- responseCode "AB"|"IP"|"UQ"|"CA"|"RE"|"AP"|"PD" - The response code. For details see https://docs.peppol.eu/poacc/upgrade-3/codelist/UNCL4343-T111/. For invoices received through the French (fr-dgfip) workflow, Storecove delivers the response to the supplier over Peppol using the corresponding French lifecycle (CDV) status: AB/AP as 205 Approuvée, IP as 204 Prise en charge, CA as 206 Approuvée partiellement, UQ as 207 En litige, RE as 210 Refusée and PD as 211 Paiement transmis. Only RE (210 Refusée) is subsequently reported to the PPF; facultative statuses (204–207, 211) are Peppol-only and are never transmitted to the tax administration. See the France appendix for details
storecove: DocumentOrder
The order to send
Fields
- orderType "regular"|"consignment" (default "regular") - The type of this order
- note? string - A note to add to the document
- delivery? Delivery -
- deliveryTerms? DeliveryTerms -
- accountingCost? string - The buyer's accounting cost centre for this document
- attachments? Attachment[] - An array of attachments. You may provide up to 10 attchments, but the total size must not exceed 100MB after Base64 encoding
- references? Reference[] - 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
- issueTime? string - Format: hh:mm:ss
- documentNumber string - The number you assigned to the document
- timeZone? string - 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
- buyerCustomerParty? BuyerCustomerPartyOrder - The buyer sending the order
- validityPeriod? string - The period (or specific date) to which the invoice applies. Format: yyyy-mm-dd - yyyy-mm-dd
- documentCurrencyCode? CurrencyCode - The ISO 4217 currency code
- sellerSupplierParty SellerSupplierParty - The party sending the order
- allowanceCharges? AllowanceCharge[] - An array of allowance charges
- orderLines OrderLine[] - An array of order lines
- taxSystem "tax_line_percentages" (default "tax_line_percentages") - The tax system used for the invoice. The system 'tax_line_percentages' is the only one currently supported
- issueDate string - Format: yyyy-mm-dd
- amountIncludingTax decimal - Total amount including Tax
- paymentTerms? PaymentTerms - 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).
storecove: DocumentSubmission
The document you want Storecove to send, with some meta-data
Fields
- routing? Routing - 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
- attachments? Attachment[] - 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
- legalEntityId? int - 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
- receiveGuid? string - DEPRECATED. The GUID that was in the received_document webhook. Use forDocumentGuid instead
- idempotencyGuid? string - 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
- document? SendableDocument - The document to send
- forDocumentGuid? string - 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
- forDocumentSubmissionGuid? string - 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
- createPrimaryImage? boolean - 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
storecove: DocumentSubmissionEvidence
Fields
- receiver? string - The legal identifier of the receiver, or the tax identifier if there is no legal identifier
- evidence? DocumentSubmissionEvidenceEvidence -
- sender? string - The legal identifier of the sender, or the tax identifier if there is no legal identifier
- documents? DocumentSubmissionEvidenceDocument[] - 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
- guid? string - The guid for the InvoiceSubmission
- network? "storecove"|"as2"|"email"|"peppol"|"dbnalliance"|"sdi"|"in-irp"|"pt-b2b"|"ch-qrbill"|"finvoice"|"pl-ksef"|"spain-face"|"spain-faceb2b"|"my-lhdnm"|"ae-fta" - The network that was used to clear or send the document
storecove: DocumentSubmissionEvidenceDocument
Fields
- expiresAt? string - The datetime the URL expires. Format: 'YYYY-MM-DD HH:mm:ss.'
- mimeType? "message/rfc822"|"application/xml"|"application/json"|"application/pdf"|"application/pkcs7-mime" - The mime type of the document
- document? string - The URL where the document can be retrieved
storecove: DocumentSubmissionEvidenceEvidence
Fields
- remoteMtaIp? string - The IP address of the sending SMTP server. Only used for network "email"
- signature? string - The signature assiged by the tax authority or its authorized partner. Used for network india
- receivingAccesspoint? string - An identification of the OpenPeppol accesspoint that the invoice was sent to. Only used for exchange networks like peppol and dbnalliance
- messageId? string - 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
- acknowledgementId? string - Only used for application sg-iras
- documentId? string - The UUID in the generated XML document. Only used for application my-lhdnm and sg-iras
- smtpResponse? string - The response of the receiving SMTP server. Only used for network "email"
- partnerKey? string - The meaning of this field varies, depending on the network. For my-lhdnm, it is the UUID
- 'xml? string - The XML evidence for the transmission. This is the XML returned by the receiving accesspoint, either OpenPeppol or DBNAlliance
- longId? string - Only used for application my-lhdnm
- signatureNumber? string - The sequence number of the signature assiged by the tax authority or its authorized partner. Used for network india
- correlationId? string - Only used for application sg-iras
- qrCode? string - The QR Code assiged by the tax authority or its authorized partner. Used for networks india and pt-b2b
- reportingMta? string - An identification for the sending SMTP. Only used for network "email"
- transmissionId? string - The unique id for this transmission. The meaning of this field varies, depending on the network
- signatureDateTime? string - The datetime of the signature assiged by the tax authority or its authorized partner. Used for network india
- timestamp? string - The timestamp of the delivery to the receiving SMTP server. Only used for network "email"
storecove: DocumentSubmissionResult
The result of a document submission
Fields
- guid? string - A (V4) GUID for the document submission
storecove: Envelope
Information for the envelope of the document
Fields
- typeVersion? "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" - The version of the type. Only used and mandatory for EDIFACT and X12 documents
- receiver string - The receiver of the document. For UBL documents, this is the AccountingCustomerParty/EndpointID
- sender string - The sender of the document. For UBL documents, this is the AccountingSupplierParty/EndpointID
- mimeType? string - 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
storecove: EnvelopedData
A document to send, in base64 encoded format, to be wrapped in an envelope
Fields
- processIdSchemeId "cenbii-procid-ubl" - The process id scheme id of the document
- envelope Envelope - Information for the envelope of the document
- metadata Metadata - Metadata about the document, used in the UI and reporting
- application "peppol"|"dbnalliance" - The application to use to send the document
- processId string - The process id of the document
- document string - The base64 encoded version of the document
- documentId string - The document type id of the document
- documentIdSchemeId "busdox-docid-qns"|"peppol-doctype-wildcard"|"bdx-docid-qns" - The document id scheme id of the document
storecove: FrEReport
E-reporting payload for France (DGFiP). Send with document.documentType "fr_e_report". The platform submits the report (FFE1025A) in the fr-dgfip workflow. Both camelCase frEReport and snake fr_e_report keys are accepted in the request body; the public schema uses frEReport. G6.29: exactly one of transactionReport (TB-2) or paymentReport (TB-3) must be present — not both, not neither (enforced at submission time; not expressible in OpenAPI 2.0). See also the France appendix in the API documentation
Fields
- typeCode string - e.g. IN (initial) or RE (rectificative).
- documentId string - Identifier for this report instance.
- issueDate string - Format: yyyy-mm-dd.
- issueTime string - Format: hh:mm:ss (24-hour).
- timeZone string - Format: ±zzzz, where ±zzzz is the difference from UTC, e.g. +0100 or -0900. Applies to the report issue time (and, where relevant, the issue date context for processing).
- declarantParty FrEReportDeclarantParty -
- transactionReport? FrEReportTransactionReport -
- paymentReport? FrEReportPaymentReport -
storecove: FrEReportB2bCrossBorderInvoice
Structured like a full invoice: identifiers, parties, taxSubtotals, and invoice lines
Fields
- invoiceNumber? string -
- frCadreDeFacturation? "B1"|"S1"|"M1"|"B2"|"S2"|"M2"|"B4"|"S4"|"M4"|"S5"|"S6"|"B7"|"S7" - The French invoicing context (Cadre de Facturation) for this cross-border B2B line in a Flux 10 transaction report. Maps to Invoice/BusinessProcess/ID. Allowed values are the Flux 10 G1.02 list (Annexe 7). Optional; when omitted the platform emits B1. Do not send F1-only values (S3, B8, S8, M8).
- issueDate string - Format: yyyy-mm-dd.
- dueDate? string - Format: yyyy-mm-dd.
- documentCurrency? string -
- amountIncludingVat decimal -
- taxSubtotals? record {}[] -
- accountingSupplierParty? AccountingSupplierParty - 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
- accountingCustomerParty? AccountingCustomerParty - The customer receiving the document
- invoiceLines? InvoiceLine[] -
- references? Reference[] - For credit notes (negative amountIncludingVat): must contain a documentType='billing' entry with both documentId and issueDate pointing to the original invoice being corrected (F10 schematron G1.32b, fatal; issueDate is mandatory, not optional, for this header-level reference).
storecove: FrEReportB2bPayment
Fields
- invoiceNumber? string -
- issueDate? string - Format: yyyy-mm-dd.
- paymentDate? string - Format: yyyy-mm-dd.
- amount? decimal -
- currency? string -
- paymentMeansCode? string -
- taxSubtotals? record {}[] -
storecove: FrEReportB2cPayment
Payment-report aggregate for B2C: the platform uses date and taxSubtotal to build the submitted report. Put currency and per-rate amounts on each taxSubtotal line; a top-level currency (if present) is not used for the France payment XML. Do not use the B2C transaction aggregate field set here (vatPaymentOption, category, amountExcludingVat, amountIncludingVat, transactionsCount, transaction-style taxSubtotals); those are only for b2cTransactions rows
Fields
- date? string - Format: yyyy-mm-dd.
- currency? string - Optional. Not read by the payment-aggregate mapping; set
currencyon eachtaxSubtotalrow for output.
- taxSubtotal? record {}[] -
storecove: FrEReportB2cTransaction
Fields
- date string - Format: yyyy-mm-dd.
- currency? string -
- vatPaymentOption? string -
- category "TLB1"|"TPS1"|"TNT1"|"TMA1" - Flux 10 CategoryCode (Annexe 7 G1.68). Required; omitting it or sending a blank/unknown value makes PPF reject the archive as IRR_SYNTAX.
- amountExcludingVat? decimal -
- amountIncludingVat? decimal -
- transactionsCount? int -
- taxSubtotals? record {}[] -
storecove: FrEReportDeclarantParty
Fields
- party? FrEReportParty - Legal name and address fields as used in e-reporting samples
- publicIdentifiers PublicIdentifier[] -
storecove: FrEReportParty
Legal name and address fields as used in e-reporting samples
Fields
- companyName? string -
storecove: FrEReportPaymentReport
Fields
- period string - The period the payment report covers. Format: yyyy-mm-dd - yyyy-mm-dd.
- b2biPayments? FrEReportB2bPayment[] - Payments for B2B / cross-border invoices in scope.
- b2cPayments? FrEReportB2cPayment[] - B2C payment aggregates. Each item supplies the payment
dateand ataxSubtotallist (per-rate amounts and currency; see the shared converter). Other keys are ignored.
storecove: FrEReportTransactionReport
Fields
- period string - The period the transaction report covers. Format: yyyy-mm-dd - yyyy-mm-dd.
- b2biInvoices? FrEReportB2bCrossBorderInvoice[] - B2B cross-border invoices to report (sales and received cross-border lines as in the DGFiP test cases).
- b2cTransactions? FrEReportB2cTransaction[] - Aggregated B2C transactions in France for the period.
storecove: GetPurchaseInvoicePackagedQueries
Represents the Queries record for the operation: getPurchaseInvoicePackaged
Fields
- pmv string(default "1.0") - DEPRECATED. The PaymentMeans version. The default (and deprecated) version 1.0 will give BankPaymentMean, DirectDebitPaymentMean, CardPaymentMean, NppPaymentMean, SeBankGiroPaymentMean, SePlusGiroPaymentMean, SgCardPaymentMean, SgGiroPaymentMean, SgPaynowPaymentMean. Version 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
- version string(default "1970-01-01") - 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'
storecove: GetPurchaseInvoiceQueries
Represents the Queries record for the operation: getPurchaseInvoice
Fields
- pmv string(default "1.0") - DEPRECATED. The PaymentMeans version. The default (and deprecated) version 1.0 will give BankPaymentMean, DirectDebitPaymentMean, CardPaymentMean, NppPaymentMean, SeBankGiroPaymentMean, SePlusGiroPaymentMean, SgCardPaymentMean, SgGiroPaymentMean, SgPaynowPaymentMean. Version 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
- version string(default "1970-01-01") - 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
storecove: GetReceivedDocumentQueries
Represents the Queries record for the operation: getReceivedDocument
Fields
- version string(default "1970-01-01") - 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
storecove: GovernmentReceiver
The government receiver of the document
Fields
- routing? CountrySpecificationIdentifier -
- legal? CountrySpecificationIdentifier -
storecove: Invoice
The invoice to send. Provide either invoice, or invoiceData, but not both
Fields
- billingFrequency? "DLY"|"WKY"|"Q15"|"MTH"|"Q45"|"Q60"|"QTR"|"HYR"|"YRL"|"OTH" - The frequency of billing (BTAE-06). Only used when the sender country is AE (PINT-AE), where it is mandatory for summary invoices and continuous supplies. Maps to UBL InvoicePeriod/DescriptionCode. Values: DLY (daily), WKY (weekly), Q15 (every 15 days), MTH (monthly), Q45 (every 45 days), Q60 (every 60 days), QTR (quarterly), HYR (half-yearly), YRL (yearly), OTH (other; requires a note describing the frequency). See <<country_ae>>
- salesOrderId? string - DEPRECATED. Use a reference object with a documentType 'sales_order'. A reference to an order for this invoice, assigned by the seller
- contractDocumentReference? string - DEPRECATED. Use a reference object with a documentType 'contract'. A reference to a contract or framework agreement that this invoice relates to
- accountingCost? string - The buyer's accounting cost centre for this invoice, expressed as text
- notes? string[] - An array of notes to add to the invoice
- references? Reference[] - 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
- prepaidAmount? decimal - 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
- dueDate? string - Format: yyyy-mm-dd
- paymentMeansIban? string - DEPRECATED. Use paymentMeansArray. The IBAN the amount payable should be transferred to
- vatReverseCharge boolean(default false) - DEPRECATED. Use taxExemptReason
- taxSubtotals? TaxSubtotal[] - An array of tax subtotals. This element is mandatory for taxSystem 'tax_line_percentages'
- accountingCurrencyTaxAmountCurrency? CurrencyCode - The ISO 4217 currency code
- allowanceCharges? AllowanceCharge[] - An array of allowance charges
- invoiceLines InvoiceLine[] - An array of invoice lines
- consumerTaxMode boolean(default false) - 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
- invoiceType "380"|"383"|"381"|"384"|"261"|"527"|"389" (default "380") - 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
- frCadreDeFacturation? "B1"|"S1"|"M1"|"B2"|"S2"|"M2"|"S3"|"B4"|"S4"|"M4"|"S5"|"S6"|"B7"|"S7"|"B8"|"S8"|"M8" - The French invoicing context (Cadre de Facturation). Identifies the use case for the document under the French e-invoicing reform (Facturation Electronique). Maps to UBL ProfileID and CII BusinessProcessSpecifiedDocumentContextParameter/ID
- paymentTerms? PaymentTerms - 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).
- salesAgentParty? SalesAgentParty - An agent acting on behalf of the seller. Used in the French e-invoicing reform (FR-FE EXT-FR-FE-BG-03). Maps to UBL AccountingSupplierParty/Party/AgentParty and CII SalesAgentTradeParty
- taxAuthority? TaxAuthority - Information relating to a tax authority
- accountingCustomerParty AccountingCustomerParty - The customer receiving the document
- creditNoteReasonCode? "DL8.61.1.A"|"DL8.61.1.B"|"DL8.61.1.C"|"DL8.61.1.D"|"DL8.61.1.E"|"VD" - The reason the credit note is issued (BTAE-03). Only used when the sender country is AE (PINT-AE), where it is mandatory for credit notes. Maps to UBL DiscrepancyResponse/ResponseCode. Values: DL8.61.1.A (supply cancelled), DL8.61.1.B (supply not provided as agreed), DL8.61.1.C (goods or services returned in full or part), DL8.61.1.D (change in consideration), DL8.61.1.E (incorrect tax treatment), VD (volume discount; the only reason that does not require a billing reference to the preceding invoice). See <<country_ae>>
- buyerReference? string - DEPRECATED. Use a reference object with a documentType 'buyer_reference'. A reference provided by the buyer used for internal routing of the document
- ublExtensions? string[] - An array of ubl extensions
- timeZone? string - 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
- aeTransactionType? AETransactionType - The UAE invoice transaction type (BTAE-02). Only used when the sender country is AE (PINT-AE). Each flag marks whether the corresponding transaction characteristic applies to the document. All flags default to false. Maps to UBL ProfileExecutionID as an 8-character string of 0/1 flags in the order: free trade zone, deemed supply, margin scheme, summary invoice, continuous supply, disclosed agent billing, e-commerce, exports. See <<country_ae>>
- taxPointDateCode? "3"|"35"|"432" - The code describing which date is used as the tax point date. Maps to UBL InvoicePeriod/DescriptionCode and CII ApplicableTradeTax/DueDateTypeCode. Supported values: 3 (invoice issue date), 35 (actual delivery date), 432 (paid to date)
- billingReference? string - 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
- orderReference? string - 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
- subType? "invoice"|"creditnote"|"debitnote"|"correctioninvoice" - The document subtype. Only used for received invoices, not for sending
- amountIncludingTax? decimal - EXPERIMENTAL for sending. The amountIncludingTax is the payable amount, but not corrected for the prepaid amount
- amountIncludingVat? decimal - 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
- payeeParty? PayeeParty - 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
- sellerAdditionalTaxIdentifierCountry? string - Optional ISO 3166-1 alpha-2 country of an AdditionalTaxIdentifier on the sending LegalEntity. When set, that identifier is used for the seller PartyTaxScheme (ShipToVat / local VAT scenarios) instead of the LegalEntity primary tax identifier. Omit unless you need this. Incompatible with selfBillingMode. All invoiceLines tax.country and taxSubtotals country values must match. Not used for receiving
- projectReference? string - DEPRECATED. Information about the project this invoice relates to
- note? string - DEPRECATED. Use notes instead
- attachments? Attachment[] - An array of attachments. You may provide up to 10 attchments, but the total size must not exceed 100MB after Base64 encoding
- priceMode "price_mode_net"|"price_mode_gross" (default "price_mode_net") - 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
- buyerAgentParty? BuyerAgentParty - An agent acting on behalf of the buyer. Used in the French e-invoicing reform (FR-FE EXT-FR-FE-BG-01). Maps to UBL AccountingCustomerParty/Party/AgentParty and CII BuyerAgentTradeParty
- issueTime? string - Format: hh:mm:ss
- accountingCurrencyExchangeRate? decimal - Rate at which the document currency must be multiplied to convert it into the accounting currency. If included, must be non-zero
- documentUuid? string - A universally unique identifier for the document. Used for SG and AE senders and mapped to UBL cbc:UUID; for PINT-AE this is BTAE-07. If an AE submission omits it, Storecove generates one at submission time. Format: UUID (RFC 4122). For AE usage see <<country_ae>>
- preferredInvoiceType "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") - 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
- creditNoteTypeCode "81"|"83"|"261"|"262"|"381"|"396"|"502"|"503"|"532" (default "381") - The credit note type code (UNCL1001 subset), if a credit note is sent. The schema accepts every code that any supported destination accepts; the actual allowed subset is enforced per destination when the document is sent. Peppol BIS Billing 3.0 (default, UNCL1001-cn): 81, 83, 381, 396, 532. Peppol BIS Self-Billing 3.0 (when selfBillingMode is true, UNCL1001-sbcn): 261. Peppol PINT senders use the normal PINT subset for their sender country regardless of receiver country: AE = 81, 381; SG = 81, 83, 381, 396, 532; AU, NZ and MY = 81, 83, 381, 396, 532. In self-billing mode, AE, AU, NZ and MY use 261. Japan (JP) senders cannot send credit notes on Peppol PINT; Japan does not use credit notes. France (FR-DGFiP): 261 (Avoir auto-facturé), 262 (Avoir pour Remise Globale), 381 (Avoir), 396 (Avoir affacturé), 502 (Avoir auto-facturé affacturé), 503 (Avoir de facture d'acompte). France-domestic credit notes sent over Peppol BIS (sender country FR and buyer country FR) use the French list instead of the Peppol BIS list. Other UNCL1001 codes must not be used
- paymentMeansBic? string - DEPRECATED. Use paymentMeansArray. The BIC (Swift) of the bank where the amount payable should be transferred to
- taxPointDate? string - 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
- issueReasons? string[] - An array reasons for issuing the invoice
- prepaidPayments? PrepaidPayment[] - 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
- invoiceeParty? InvoiceeParty - The party that is being invoiced when different from the buyer. Used in the French e-invoicing reform (FR-FE EXT-FR-FE-BG-04). Maps to UBL AccountingCustomerParty/Party/ServiceProviderParty/Party and CII InvoiceeTradeParty
- accountingCurrencyTaxableAmount? decimal - The taxable amount in the accounting currency. If included, must be non-zero
- accountingCurrencyTaxAmount? decimal - The total amount of tax in the accounting currency. If included, must be non-zero
- productionDate? string - Date the invoice was produced. Format: yyyy-mm-dd. Only used for PL KSeF, where it becomes Naglowek/DataWytworzeniaFa. Send it together with productionTime and productionTimeZone, or omit all three. When all three are omitted, Storecove uses the time it generates the FA(3) XML. This is not the issue date. A date before 2025-09-01 is rejected
- selfBillingMode boolean(default false) -
- invoicePeriod? string - The period (or specific date) to which the invoice applies. Format: yyyy-mm-dd - yyyy-mm-dd
- invoiceNumber string - The invoice number you assigned to the invoice
- issueDate string - Format: yyyy-mm-dd
- taxExemptReason? "export"|"reverse_charge"|"zero_rated"|"exempt"|"outside_scope"|"intra_community" - 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
- accountingSupplierParty? AccountingSupplierParty - 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
- payerParty? PayerParty - The party that pays the invoice when different from the buyer. Used in the French e-invoicing reform (FR-FE EXT-FR-FE-BG-02). Maps to UBL PaymentMeans/PaymentMandate/PayerParty and CII PayerTradeParty
- delivery? Delivery -
- deliveryTerms? DeliveryTerms -
- invoicerParty? InvoicerParty - The party that issues the invoice on behalf of the seller. Used in the French e-invoicing reform (FR-FE EXT-FR-FE-BG-05). Maps to UBL AccountingSupplierParty/Party/ServiceProviderParty/Party and CII InvoicerTradeParty
- payableRoundingAmount? decimal - 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
- paymentMeansArray? PaymentMeans[] - An array of payment means (ways to pay the invoice)
- transactionType? "b2b"|"sezwp"|"sezwop"|"expwp"|"expwop"|"dexp" - The type of transaction. Currently used only for India
- documentCurrencyCode? CurrencyCode - The ISO 4217 currency code
- paymentMeansCode? "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" - 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
- connectedUnderPlArticle32? boolean - Whether the buyer and the seller are connected under art. 32 ust. 2 of the Polish VAT Act. Only used for PL KSeF. When true, Storecove writes Fa/TP as 1. When false or omitted, Fa/TP is left out. The public-sector exception in ust. 4b is the sender's decision
- invoiceTypeCode "71"|"80"|"82"|"84"|"102"|"218"|"219"|"326"|"331"|"380"|"382"|"383"|"384"|"386"|"388"|"389"|"393"|"395"|"471"|"472"|"473"|"480"|"500"|"501"|"527"|"553"|"575"|"623"|"780"|"817"|"870"|"875"|"876"|"877" (default "380") - The invoice type code (UNCL1001 subset), if an invoice is sent. The schema accepts every code that any supported destination accepts; the actual allowed subset is enforced per destination when the document is sent. Peppol BIS Billing 3.0 (default, UNCL1001-inv): 71, 80, 82, 84, 102, 218, 219, 326, 331, 380, 382, 383, 384, 386, 388, 389, 393, 395, 553, 575, 623, 780, 817, 870, 875, 876, 877. Peppol BIS Self-Billing 3.0 (when selfBillingMode is true, UNCL1001-sbinv): 389, 527. Peppol PINT senders use the normal PINT subset for their sender country regardless of receiver country: AE = 380, 480; SG = 71, 80, 82, 84, 102, 218, 219, 331, 380, 382, 383, 386, 388, 393, 395, 480, 553, 575, 623, 780, 817, 870, 875, 876, 877; AU, NZ, JP and MY = 71, 80, 82, 84, 102, 218, 219, 331, 380, 382, 383, 386, 388, 393, 395, 480, 553, 575, 623, 780, 817, 870, 875, 876, 877. In self-billing mode, AE, AU, NZ, JP and MY use 389. France (FR-DGFiP): 380 (Facture commerciale), 384 (Facture rectificative), 386 (Facture d'acompte), 389 (Facture auto-facturée), 393 (Facture affacturée), 471 (Facture rectificative auto-facturée), 472 (Facture rectificative affacturée), 473 (Facture rectificative auto-facturée affacturée), 500 (Facture d'acompte auto-facturée), 501 (Facture auto-facturée affacturée). France-domestic invoices sent over Peppol BIS (sender country FR and buyer country FR) use the French list instead of the Peppol BIS list. Other UNCL1001 codes must not be used
- taxSystem "tax_line_amounts"|"tax_line_percentages" (default "tax_line_amounts") - 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>>)
- taxesDutiesFees? Tax[] - 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'
- productionTime? string - Time the invoice was produced. Format: hh:mm:ss. Only used for PL KSeF. Send it together with productionDate and productionTimeZone, or omit all three
- paymentMeansPaymentId? string - DEPRECATED. Use the paymentId in the individual PaymentMeans object. The payment id that you will use to match the payment against the invoice
- productionTimeZone? string - Timezone of the production time. Format: ±zzzz, for example +0100 or -0900. Only used for PL KSeF. Send it together with productionDate and productionTime, or omit all three
- x2y "b2b"|"b2g"|"b2c"|"b2b_sez"|"petty_cash"|"b2c_point_of_sale"|"b2c_simplified_tax_invoice"|"b2c_petty_cash" (default "b2b") - 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
storecove: InvoiceData
DEPRECATED. Use RawDocumentData. The invoice to send, in base64 encoded format. Provide either invoice, or invoiceData, but not both
Fields
- conversionStrategy? "ubl"|"cii"|"idoc"|"setu14" - How to interpret the document
- document? string - The base64 encoded version of the document
storecove: InvoiceeParty
The party that is being invoiced when different from the buyer. Used in the French e-invoicing reform (FR-FE EXT-FR-FE-BG-04). Maps to UBL AccountingCustomerParty/Party/ServiceProviderParty/Party and CII InvoiceeTradeParty
Fields
- publicIdentifiers? PublicIdentifier[] - A list of legal and tax identifiers for this party
- party Party - A party that can receive or send invoices
storecove: InvoiceLine
Fields
- natureCode? "DL8.48.8.2"|"DL8.48.8.1"|"DL8.48.3.1"|"DL8.48.3.2"|"DL8.48.3.3" - The type of goods or services subject to the reverse charge mechanism (BTAE-09). Only used when the sender country is AE (PINT-AE), where it is mandatory for lines with tax category 'reverse_charge'. Maps to UBL CommodityClassification/NatureCode. Values must be from the UAE GoodsType / RCM code list (DL8.48.8.2, DL8.48.8.1, DL8.48.3.1, DL8.48.3.2, DL8.48.3.3). See <<country_ae>>
- note? string - DEPRECATED. Use notes instead. A note to add to the document line
- additionalItemProperties? AdditionalItemProperty[] - An array of additional item properties
- itemType? "G"|"S"|"B" - Whether the invoiced item concerns goods (G), services (S) or both (B) (BTAE-13). Only used when the sender country is AE (PINT-AE). Maps to UBL CommodityClassification/CommodityCode. When G or B, an item classification code with documentIdListId 'HS' is required in the references array (documentType 'item_classification_code'). When S or B, a serviceAccountingCode is required. See <<country_ae>>
- accountingCost? string - The buyer's accounting cost centre for this invoice line, expressed as text
- notes? string[] - An array of notes attached to this invoice line. Used for the French e-invoicing reform (FR-FE EXT-FR-FE-183) and equivalent constructs in other syntaxes
- references? Reference[] - 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
- description? string - The description for this invoice line
- standardItemIdentificationSchemeId string(default "GTIN") - DEPRECATED. Use the references array with 'line_standard_item_identification' documentType. The scheme for the standardized ID for the item
- allowanceCharges? LineAllowanceCharge[] - An array of allowances and charges
- baseQuantity? decimal - DEPRECATED. Use price.baseQuantity instead. The number of items (may be fractional) the price is for
- invoicePeriod? string - The period (or specific date) to which the invoice line applies. Format: yyyy-mm-dd - yyyy-mm-dd
- price? Price - The price details for the invoice line
- orderLineReferenceLineId? string - 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
- buyersItemIdentification? string - DEPRECATED. Use the references array with 'line_buyers_item_identification' documentType. The ID the buyer assigned to this item
- allowanceCharge? decimal - DEPRECATED. Use allowanceCharges. The discount or surcharge on this item. Should be negative for discounts
- amountExcludingVat? decimal - The amount excluding tax. Should equal price.priceAmount x quantity / price.baseQuantity + line-level allowanceCharges. Price-level discounts are already included in priceAmount
- quantity? decimal - The number of items (may be fractional)
- amountExcludingTax? decimal - The amount excluding tax. EXPERIMENTAL for sending. Should equal price.priceAmount x quantity / price.baseQuantity + line-level allowanceCharges. Price-level discounts are already included in priceAmount
- lineId? string - The id for this invoice line
- tax? Tax -
- serviceAccountingCode? string - The service accounting code (SAC) of the invoiced service (BTAE-17). Only used when the sender country is AE (PINT-AE), where it is mandatory when itemType is S or B. Maps to UBL AdditionalItemIdentification with schemeID 'SAC'. See <<country_ae>>
- quantityUnitCode "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") - 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
- standardItemIdentification? string - DEPRECATED. Use 'line_standard_item_identification'. Standardized ID for the item
- standardItemIdentificationSchemeAgencyId string(default "9") - DEPRECATED. Use the references array with 'line_standard_item_identification' documentType. The scheme agency for the standardized ID for the item
- name? string - 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
- itemPrice? decimal - DEPRECATED. Use price.priceAmount instead. The net price per baseQuantity (may be fractional). This field remains available for compatibility with older connections
- taxesDutiesFees? Tax[] - 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
- amountIncludingTax? decimal - The amount including tax. Can only be used for "priceMode": "price_mode_gross". Use either this property or amountExcludingTax (amountExcludingVat)
- sellersItemIdentification? string - DEPRECATED. Use the references array with 'line_sellers_item_identification' documentType. The ID the seller assigned to this item
storecove: InvoiceRecipient
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
Fields
- emails? string[] - The email addresses the invoice should be sent to if none of the other identifiers can be used
- publicIdentifiers? PublicIdentifiers - A list of public identifiers that uniquely identify this customer
storecove: InvoiceRecipientPreflight
Identifies the invoice recipient to preflight
Fields
- publicIdentifiers? PublicIdentifiers - A list of public identifiers that uniquely identify this customer
storecove: InvoiceResponseClarification
A clarification for why a received invoice was rejected (RE) or under query (UQ) and what action to take
Fields
- clarificationCode? "NON"|"REF"|"LEG"|"REC"|"QUA"|"DEL"|"PRI"|"QTY"|"ITM"|"PAY"|"UNR"|"FIN"|"PPD"|"OTH"|"NOA"|"PIN"|"NIN"|"CNF"|"CNP"|"CNA" - The code for the clarification. It must be valid for the clarificationCodeType: reason codes (OPStatusReason) are NON, REF, LEG, REC, QUA, DEL, PRI, QTY, ITM, PAY, UNR, FIN, PPD and OTH; action codes (OPStatusAction) are NOA, PIN, NIN, CNF, CNP, CNA and OTH. PPD can only be used with responseCode PD, and PPD/OTH require a clarification text. For details see https://docs.peppol.eu/poacc/upgrade-3/codelist/OPStatusReason/ and https://docs.peppol.eu/poacc/upgrade-3/codelist/OPStatusAction/. For invoices received through the French (fr-dgfip) workflow, the reason code is mapped to the corresponding French CDAR motif (MDT-113) in the Peppol-delivered CDAR; for RE responses only, that motif is also reported to the PPF
- clarification? string - A textual description of the clarification. Mandatory when clarificationCode is PPD or OTH
- clarificationCodeType? "OPStatusReason"|"OPStatusAction" - The type of the clarification: "OPStatusReason" for a status reason (why the invoice has this status), "OPStatusAction" for a requested action. The clarificationCode must belong to the code list of this type. For invoices received through the French (fr-dgfip) workflow this field is mandatory for every clarification that carries a clarificationCode, and responses CA, UQ and RE require at least one clarification of type OPStatusReason
- conditions? InvoiceResponseCondition[] - A list of conditions that triggered the error. This is only included for receiving in webhooks. You cannot currently send these conditions
storecove: InvoiceResponseCondition
Specifies an error in the received invoice
Fields
- fieldCode string - 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
- fieldValue string - The (error) value of the field
storecove: InvoicerParty
The party that issues the invoice on behalf of the seller. Used in the French e-invoicing reform (FR-FE EXT-FR-FE-BG-05). Maps to UBL AccountingSupplierParty/Party/ServiceProviderParty/Party and CII InvoicerTradeParty
Fields
- publicIdentifiers? PublicIdentifier[] - A list of legal and tax identifiers for this party
- party Party - A party that can receive or send invoices
storecove: InvoiceSubmission
DEPRECATED. The invoice you want Storecove to process, with some meta-data
Fields
- invoiceData? InvoiceData - DEPRECATED. Use RawDocumentData. The invoice to send, in base64 encoded format. Provide either invoice, or invoiceData, but not both
- supplierId? int - DEPRECATED
- attachments? Attachment[] - An array of attachments. You may provide up to 10 attchments, but the total size must not exceed 100MB after Base64 encoding
- idempotencyGuid? string - 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
- document? string - DEPRECATED. Use attachments
- documentUrl? string - DEPRECATED. Use attachments
- legalSupplierId? int - DEPRECATED. Use legalEntityId
- createPrimaryImage? boolean - 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
- invoiceRecipient? InvoiceRecipient - 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
- mode? "direct" - DEPRECATED
- routing? Routing - 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
- legalEntityId? int - The id of the LegalEntity this invoice should be sent for
- invoice? Invoice - The invoice to send. Provide either invoice, or invoiceData, but not both
storecove: InvoiceSubmissionActionEvidence
Fields
- receiverResponse? string - The response the receiver sent
- transmittedDocument? string - The document that was transmitted
- transmissionType? "ae-fta"|"as2"|"bpc"|"ch-qrbill"|"edi"|"email"|"es-aeat-verifactu"|"exact_worker"|"finvoice"|"fr-dgfip"|"fr-dgfip-cdar"|"india"|"india-b2c"|"italy-aruba"|"my-lhdnm"|"peppol"|"pl-ksef"|"pt-b2b"|"ro-arxia-anaf"|"sa"|"sandbox"|"sg-iras"|"snelstart_worker"|"spain-face"|"spain-faceb2b"|"svefaktura"|"vatcalc" - How the document was transmitted. Matches the sending application name (for example pl-ksef for Poland KSeF)
- transmissionResult? "unknown"|"accepted"|"rejected"|"send_error"|"internal_error"|"no_clearing_status"|"pending_clearance"|"sent_pending_confirmation"|"cleared"|"not_clearable"|"clearing_transport_error" - The result of this transmission
- transmissionDatetime? string - The DateTime of the transmission, as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
storecove: InvoiceSubmissionEvidence
Fields
- guid? string - The guid for the InvoiceSubmission
- actions? InvoiceSubmissionActionEvidence[] - An array of actions taken to deliver the document
- status? string - The overall status for this InvoiceSubmission
storecove: InvoiceSubmissionResult
The result of an invoice submission
Fields
- guid? string - A (V4) GUID for the invoice submission
storecove: LegalEntity
Fields
- Fields Included from *LegalEntityUpdate
- zip string
- tenantId string
- country Country
- actsAsReceiver boolean
- city string
- taxRegistered boolean
- classificationCode string
- county string
- registrationAuthorityName string
- rea ReaRegistration
- smartInbox string
- advertisements "invoice"|"invoice_response"|"selfbilling"|"order"|"ordering"|"advanced_ordering"|"advanced_ordering_sg_order_balance"|"remittance_advice"|"despatch_advice"|"pidx_invoicing_ordering"[]
- thirdPartyPassword string
- actsAsSender boolean
- partyName string
- public boolean
- passportIssuingCountry string
- thirdPartyUsername string
- id int
- line2 string
- overrideOwnCredentials boolean
- line1 string
- anydata...
- Fields Included from *LegalEntityPeppolIdentifiers
- peppolIdentifiers PeppolIdentifier[]
- anydata...
- Fields Included from *LegalEntityAdditionalTaxIdentifiers
- additionalTaxIdentifiers AdditionalTaxIdentifier[]
- anydata...
- Fields Included from *LegalEntityApiKeys
- apiKeys string[]
- anydata...
storecove: LegalEntityAdditionalTaxIdentifiers
Fields
- additionalTaxIdentifiers? AdditionalTaxIdentifier[] -
storecove: LegalEntityApiKeys
Fields
- apiKeys? string[] -
storecove: LegalEntityCreate
Fields
- zip string - The zipcode
- tenantId? string - 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
- country Country - An ISO 3166-1 alpha-2 country code
- actsAsReceiver boolean(default true) - Whether or not this LegalEntity can act as a receiver of documents. If not, no identifiers will be provioned on any exchange network
- city string - The city
- taxRegistered boolean(default true) - Whether or not this LegalEntity is tax registered. This influences the validation of the data presented when sending documents
- county? string - County, if applicable
- registrationAuthorityName? string - The name of the authority that issued the legal registration identifier. Used for UAE PINT-AE BTAE-11. See <<country_ae>>
- rea? ReaRegistration -
- advertisements? ("invoice"|"invoice_response"|"selfbilling"|"order"|"ordering"|"advanced_ordering"|"advanced_ordering_sg_order_balance"|"remittance_advice"|"pidx_invoicing_ordering")[] - A list of document groups to advertise.
- thirdPartyPassword? string - 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
- actsAsSender boolean(default true) - Whether or not this LegalEntity can act as a sender of documents
- partyName string - The name of the company
- 'public boolean(default true) - Whether or not this LegalEntity is public. Public means it will be entered into the PEPPOL directory at https://directory.peppol.eu/
- passportIssuingCountry? string - The ISO 3166-1 alpha-2 country code, or Peppol extension 1A, for the authority that issued the passport. Used for UAE PINT-AE BTAE-19. See <<country_ae>>
- thirdPartyUsername? string - 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
- line2? string - The second address line, if applicable
- overrideOwnCredentials boolean(default false) - If true, Storecove will use default credentials/signing artifacts even if specific ones are configured for this LegalEntity. Defaults to false
- line1 string - The first address line
storecove: LegalEntityPeppolIdentifiers
Fields
- peppolIdentifiers? PeppolIdentifier[] -
storecove: LegalEntityUpdate
Fields
- zip? string - The zipcode
- tenantId? string - The id of the tenant, to be used in case of multi-tenant solutions. This property will included in webhook events
- country? Country - An ISO 3166-1 alpha-2 country code
- actsAsReceiver boolean(default true) - Whether or not this LegalEntity can act as a receiver of documents. If not, no identifiers will be provioned on any exchange network
- city? string - The city
- taxRegistered boolean(default true) - Whether or not this LegalEntity is tax registered. This influences the validation of the data presented when sending documents
- classificationCode? string - The classification code for this LegalEntity. For Malaysia, this is the MSIC code. It is mandatory for MY legal entities
- county? string - County, if applicable
- registrationAuthorityName? string - The name of the authority that issued the legal registration identifier. Used for UAE PINT-AE BTAE-11. See <<country_ae>>
- rea? ReaRegistration -
- smartInbox? string - DEPRECATED. Use the <<_openapi_receiveddocuments_resource>> endpoint. The email address of the Smart Inbox for this LegalEntity
- advertisements? ("invoice"|"invoice_response"|"selfbilling"|"order"|"ordering"|"advanced_ordering"|"advanced_ordering_sg_order_balance"|"remittance_advice"|"despatch_advice"|"pidx_invoicing_ordering")[] - A list of document groups to advertise.
- thirdPartyPassword? string - 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
- actsAsSender boolean(default true) - Whether or not this LegalEntity can act as a sender of documents
- partyName? string - The name of the company
- 'public boolean(default true) - 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
- passportIssuingCountry? string - The ISO 3166-1 alpha-2 country code, or Peppol extension 1A, for the authority that issued the passport. Used for UAE PINT-AE BTAE-19. See <<country_ae>>
- thirdPartyUsername? string - 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
- id? int - The Storecove assigned id for the LegalEntity
- line2? string - The second address line, if applicable
- overrideOwnCredentials boolean(default false) - If true, Storecove will use default credentials/signing artifacts even if specific ones are configured for this LegalEntity. Defaults to false
- line1? string - The first address line
storecove: LineAllowanceCharge
Fields
- reason? string - The reason for the allowance or charge, free text. Defaults to 'Mutually Agreed' if neither reason nor reasonCode are provided
- amountExcludingTax decimal - The amount for the allowance or charge, excluding tax
- reasonCode? string - The reason code for the allowance or charge
- baseAmountExcludingTax? decimal - The base amount for the allowance or charge, excluding tax
storecove: LineDelivery
Fields
- deliveryLocation? LineDeliveryDeliveryLocation -
storecove: LineDeliveryDeliveryLocation
Fields
- requestedDeliveryPeriod? string - The requested delivery period. If not present, will be taken from the document level. If that is not present, this field is mandatory
- schemeId? string - The schemeId of the location identifier (e.g. '0088')
- id? string - The location identifier
storecove: Location
The location the goods/services were delivered to
Fields
- zip? string - Address zip code
- country? string - Address country
- city? string - Address city
- schemeId? string - The scheme id for the id of the location
- county? string - Address county
- id? string - The id of the location
- neighborhood? string - The neighborhood. Used in SA
- department? string - Department name
- line2? string - Address line 2
- line1? string - Address line 1
- buildingNumber? string - The building number. Used in SA
- secondaryNumber? string - The secondary number. Used in SA
storecove: Metadata
Metadata about the document, used in the UI and reporting
Fields
- documentDate string - The date of the document. For UBL documents, this is the Invoice/IssueDate or CreditNote/IssueDate
- receiverCountry string - 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
- payloadType "Invoice"|"CreditNote"|"InvoiceResponse"|"Order"|"OrderResponse"|"DespatchAdvice"|"OrderBalance"|"OrderChange"|"OrderCancellation"|"Other" - The type of payload
- documentNumber string - The number of the document. For UBL documents, this is the Invoice/ID or CreditNote/ID
- receiverName string - The name of the receiver of the document. For UBL documents, this is the Invoice/AccountingCustomerParty/PartyName/Name or CreditNote/AccountingCustomerParty/PartyName/Name
storecove: NetworkSettings
Settings for an additional routing network
Fields
- scheme? boolean - Whether or not the network is enabled
- mock boolean(default false) - Whether or not to mock the network, if possible
storecove: NetworkSpecification
Fields
- name? "peppol"|"dbnalliance"|"dgfip" - A network to advertise the identifier on
- subNetworks? ("main"|"france"|"eb2b")[] - 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
- annuaire? DgfipAnnuaire -
storecove: OrderLine
Fields
- delivery? LineDelivery -
- note? string - A note to add to the line
- additionalItemProperties? AdditionalItemProperty[] - An array of additional item properties
- quantity decimal - The number of items (may be fractional)
- accountingCost? string - The buyer's accounting cost centre for this line
- references? Reference[] - 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
- amountExcludingTax decimal - The amount excluding tax. Should equal quantity x itemPrice + allowanceCharge
- lineId string - The id for this invoice line
- description? string - The description for this line
- quantityUnitCode "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") - 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
- lotNumberIds? OrderLineLotNumberIdsItemsString[] - An identifier for the production lot which the line items come from
- allowanceCharges? LineAllowanceCharge[] - An array of allowance charges
- baseQuantity? decimal - The number of items the price is for
- name? string - A short name for this line
- itemPrice? decimal - The price per item (may be fractional)
- allowPartialDelivery boolean(default false) - Whether or not the line items must be delivered in a single shipment
- taxesDutiesFees? Tax[] - 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
storecove: Party
A party that can receive or send invoices
Fields
- classificationCode? string - 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
- address? Address - The address
- companyName? string - The name of the company transporting the invoice
- registrationName? string - The registration name of the company transporting the invoice
- contact? Contact - Contact details for the invoice
- registrationAuthorityName? string - The name of the authority that issued the legal registration identifier (BTAE-11). Only used when the sender country is AE (PINT-AE), where it is mandatory when the party's legal registration identifier is a commercial/trade license (publicIdentifier scheme AE:TL). Maps to the schemeAgencyName attribute of UBL PartyLegalEntity/CompanyID. See <<country_ae>>
- additionalLegalInformation? string - Additional legal information relevant for the Seller
- passportIssuingCountry? string - The country that issued the passport used as the party's legal registration identifier (BTAE-19). Only used when the sender country is AE (PINT-AE), where it is mandatory when the party's legal registration identifier is a passport (publicIdentifier scheme AE:PAS). Format: ISO 3166-1 alpha-2 country code or the Peppol extension 1A; membership is enforced in Rails validation via CodeLists::Iso3166Alpha2. Maps to the schemeAgencyName attribute of UBL PartyLegalEntity/CompanyID. See <<country_ae>>
storecove: PayeeParty
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
Fields
- publicIdentifiers? PublicIdentifier[] - A list of legal and tax identifiers for this party
- party Party - A party that can receive or send invoices
storecove: PayerParty
The party that pays the invoice when different from the buyer. Used in the French e-invoicing reform (FR-FE EXT-FR-FE-BG-02). Maps to UBL PaymentMeans/PaymentMandate/PayerParty and CII PayerTradeParty
Fields
- publicIdentifiers? PublicIdentifier[] - A list of legal and tax identifiers for this party
- party Party - A party that can receive or send invoices
storecove: PaymentMeans
A PaymentMeans is a way to pay the invoice
Fields
- sepaCreditorReference? string - The SEPA creditor reference
- mandate? string - The direct debit mandate code
- amount? decimal - 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
- code "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" - How the invoice has been / will be paid. The code determines which type of PaymentMeans is used and which fields are mandatory.
- paymentId? string - The payment id that you will use to match the payment against the invoice
- brancheCode? string - The bank branch code. Not required for IBAN numbers. Often referred to as Swift or Bic code
- holder? string - The name of the account holder
- account? string - The account number
- network? string - The name of the card network, e.g. VISA
storecove: PaymentMeansDEPRECATED
DEPRECATED - Use the new payment_means_array array
Fields
- iban? string - The IBAN to which to transfer
- id? string - An id to mention in the transfer
storecove: PaymentTaxSubtotal
Fields
- remainingAmountIncludingVat? decimal - Optional. The amount still to be paid for this VAT rate, VAT included, reported as remaining to pay (RAP)
- percentage decimal - The VAT percentage the amount was received for. Must be one of the VAT percentages of the referenced invoice, which is checked when the stored payload of that invoice is still available
- currency? CurrencyCode - The ISO 4217 currency code
- amountIncludingVat decimal - The amount actually received for this VAT rate, VAT included. Negative for a refund
storecove: PaymentTerm
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
Fields
- discountPercentage? decimal - The discount percentage that applies if the invoice is settled within the required number of days. Provide only one of discountPercentage or surchargePercentage
- note? string - The note for this payment term
- surchargePercentage? decimal - The surcharge percentage that applies if the invoice is settled after the required number of days. Provide only one of discountPercentage or surchargePercentage
- settlementDays int - The number of days within which the invoice must be settled for the term to apply
- baseAmount? decimal - The base amount on which the discount percentage is applied
storecove: PaymentTerms
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).
Fields
- note? string - The note for the payment terms
- terms? PaymentTerm[] - The terms for the payment terms
storecove: PeppolIdentifier
Fields
- identifier? string - The identifier
- annuaireLineIdInstance? string - Read-only PPF idInstance for the directory line provisioned for this identifier. Omitted until the first successful sync. Present only for identifiers advertised on the "dgfip" network
- scheme? string - The scheme of the identifier. See <<_receiver_identifiers_list>> for a list
- corppass? CorpPass -
- annuaireRoutingCodeIdInstance? string - Read-only PPF idInstance for the routing code provisioned for this identifier. Omitted until the first successful sync, or when the identifier has no routing code. Present only for identifiers advertised on the "dgfip" network
- superscheme? string - The superscheme of the identifier. Should always be "iso6523-actorid-upis"
storecove: PeppolIdentifierAnnuaireUpdate
Fields
- annuaire DgfipAnnuaireUpdate -
storecove: PeppolIdentifierCreate
Fields
- identifier string - The identifier
- scheme string - The scheme of the identifier. See <<_receiver_identifiers_list>> for a list
- corppass? CorpPassCreate -
- networksSpecification? NetworkSpecification[] - A specification of the networks to advertise the identifier on
- superscheme string - The superscheme of the identifier. Should always be "iso6523-actorid-upis"
- networks? ("peppol"|"dbnalliance"|"dgfip")[] - 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
storecove: PreflightInvoiceRecipientResult
The result of preflighting an invoice recipient
Fields
- code? "ok"|"nok" - The result code of the preflight request
storecove: PrepaidPayment
A PrepaidPayment is a single prepaid payment. Each prepaid payment consists of at least the amount of the payment
Fields
- date? string - The date on which the payment was made
- reference? string - The reference of the payment
- amount decimal - The amount of the payment
- timeZone? string - 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
- time? string - The time at which the payment was made
storecove: Price
The price details for the invoice line
Fields
- allowanceCharges? PriceAllowanceCharges[] - An array of signed item-price discounts that use the same baseQuantity scale. amountExcludingTax must not be positive: zero is a no-op discount, and a price-level charge is not allowed (PEPPOL-EN16931-R044). When baseAmountExcludingTax is provided, priceAmount must equal baseAmountExcludingTax + amountExcludingTax. Only a single item is currently supported, and reason fields are not allowed
- baseQuantity? decimal - The number of items (may be fractional) the priceAmount is for
- priceAmount? decimal - The net item price per baseQuantity (may be fractional). Supersedes the deprecated itemPrice property
storecove: PublicIdentifier
A public identifier for this customer
Fields
- scheme string - The scheme of the identifier. See <<_receiver_identifiers_list>> for a list
- id string - The actual identifier
storecove: PurchaseInvoice
Fields
- legalEntityId? int - The id of the LegalEntity the invoice was received for
- note? string - The invoice level note
- externalKey? string - Deprecated. Used for accountants. The id you specified for the organization
- attachments? PurchaseInvoiceAttachment[] -
- vatReverseCharge? boolean - DEPRECATED - This is now part of each invoice line
- orderReference? string - Reference to the order. Used for matching the invoice to an order
- projectReference? string - Reference to the project
- document? string - DEPRECATED. Use the new atatchments array
- amountIncludingVat? decimal - DEPRECATED - Use amount_including_tax
- paymentMeans? PaymentMeansDEPRECATED -
- accounting? PurchaseInvoiceAccountingDetails -
- 'source? "peppol"|"script"|"supplier"|"email" - The source the invoice was received from
- paymentMeansPaymentId? string - DEPRECATED - use the payment_id property in the payment_means_array
- taxSystem? string - 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
- accountingCost? string - The accounting cost code
- paymentMeansArray? PurchaseInvoicePaymentMeans[] - The different payment means that can be used to pay the invoice
- issueDate? string - The date the invoice was issued. Format "YYYY-MM-DD"
- subType? "invoice"|"creditnote"|"correctioninvoice" - The subtype of document
- documentCurrencyCode? string - The ISO 4217 currency for the invoice
- periodStart? string - The start date of the period this invoice relates to. Format "YYYY-MM-DD"
- invoiceType? "invoice"|"creditnote"|"correctioninvoice" - The type of invoice
- invoiceNumber? string - The invoicenumber
- documentType? "invoice" - The type of document. Only "invoice" for now
- delivery? PurchaseInvoiceDelivery - The details of the delivery associated with this invoice
- taxPointDateCode? "3"|"35"|"432" - The code describing which date is used as the tax point date. Supported values: 3 (invoice issue date), 35 (actual delivery date), 432 (paid to date)
- dueDate? string - The date the invoice must be payed by. Format "YYYY-MM-DD"
- billingReference? string - Reference to the previous invoice this invoice relates to
- documentTotals? PurchaseInvoiceDocumentTotals -
- taxSubtotals? PurchaseInvoiceTaxSubtotal[] -
- taxPointDate? string - The date the invoice was issued for tax purposes. In most countries MUST match the issue_date. Format "YYYY-MM-DD"
- buyerReference? string - Reference provided by the buyer. Used for routing
- allowanceCharge? decimal - DEPRECATED - Use the allowance_charges array
- externalUserId? string - Deprecated. Used for the embedded portal retrieval service. The external_user_id you provided when the ShopAccount was created
- periodEnd? string - The end date of the period this invoice relates to. Format "YYYY-MM-DD"
- systemGeneratedPrimaryImage? boolean - 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
- sender? PurchaseInvoiceSender -
- guid? string - The GUID of the invoice
- allowanceCharges? PurchaseInvoiceAllowanceCharge[] -
- paymentTermsNote? string - A textual description of the payment terms
- contractDocumentReference? string - Reference to the contract
- invoiceLines? PurchaseInvoiceInvoiceLine[] -
storecove: PurchaseInvoiceAccountingDetails
Fields
- code? string - The the code of the general ledger account
- listVersion? string - The version of the list for the code, e.g. "1.1"
- name? string - A textual description of the code
- list? string - The name of the list for the code, e.g. "RGS"
storecove: PurchaseInvoiceAllowanceCharge
Fields
- reason? string - The reason for the allowance or charge
- vat? PurchaseInvoiceVat - DEPRECATED - Use tax
- amountExcludingTax? decimal - The amount excluding tax
- tax? PurchaseInvoiceTax -
- amountExcludingVat? string - DEPRECATED - use amount_excluding_tax
storecove: PurchaseInvoiceAttachment
Fields
- contentType? string - The attachment content type (mime type)
- document? string - The Base64 encoded document attachment
storecove: PurchaseInvoiceDelivery
The details of the delivery associated with this invoice
Fields
- actualDate? string - The actual delivery date
- location? Location - The location the goods/services were delivered to
- party? PurchaseInvoiceParty - The party the goods/services were delivered to
storecove: PurchaseInvoiceDocumentTotals
Fields
- total? decimal - 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
- payable? decimal - The total invoice amount payable including tax
- rounding? decimal - The difference between the payable amount and the total invoice amount including tax
- prepaid? decimal - The amount already paid
storecove: PurchaseInvoiceInvoiceLine
Fields
- vat? VATDetails - DEPRECATED - use tax. The VAT details for the invoice line
- description? string - The description for the invoice line
- tax? PurchaseInvoiceTax -
- units? PurchaseInvoiceInvoiceLineItem -
- accounting? PurchaseInvoiceAccountingDetails -
- allowanceCharge? decimal - DEPRECATED - use allowance_charges
- periodEnd? string - The end date of the period this invoice line relates to. Format "YYYY-MM-DD"
- periodStart? string - The start date of the period this invoice line relates to. Format "YYYY-MM-DD"
- price? PurchaseInvoiceInvoiceLinePrice -
- name? string - A short name for the invoice line
- amountExcludingTax? decimal - The amount excluding Tax. This is equal to quantity x price_amount + ∑ allowance_charges
- allowanceCharges? decimal[] - Deprecated
- allowanceChargeArray? PurchaseInvoiceInvoiceLineAllowanceCharge[] -
- amountExcludingVat? decimal - DEPRECATED - use amount_excluding_tax. The amount excluding VAT
storecove: PurchaseInvoiceInvoiceLineAllowanceCharge
Fields
- reason? string - The reason for the allowance or charge
- amount? decimal - The amount of the allowance or charge
storecove: PurchaseInvoiceInvoiceLineItem
Fields
- quantity? decimal - The quantity of the item. Can have up to digits
- unitCode? string - The unit code of the quantity
storecove: PurchaseInvoiceInvoiceLinePrice
Fields
- baseQuantity? decimal - The number of items the price is for. Can have up to digits
- priceAmount? decimal - The price for one item, excluding VAT. Can have up to digits
storecove: PurchaseInvoiceParty
The party the goods/services were delivered to
Fields
- name? string - The name of the deliveyr party
storecove: PurchaseInvoicePaymentMeans
Fields
- branchCode? string - The code identifying the bank branch. May contain a BIC/SWIFT or something appropriate for the payment method, such as "NPP" for type NppPaymentMean
- mandate? string - The mandate, used only for type DirectDebitPaymentMean
- paymentId? string - The payment id to use when making the payment. The invoice sender will use this to match the received funds to the invoice
- holder? string - The account holder name to which to transfer
- 'type? "BankPaymentMean"|"DirectDebitPaymentMean"|"CardPaymentMean"|"NppPaymentMean"|"SeBankGiroPaymentMean"|"SePlusgiroPaymentMean"|"SgCardPaymentMean"|"SgGiroPaymentMean"|"SgPaynowPaymentMean"|"CreditTransferPaymentMean"|"CreditCardPaymentMean"|"SeBankgiroPaymentMean"|"AunzNppPayidPaymentMean"|"OnlinePaymentServicePaymentMean"|"StandingAgreementPaymentMean"|"AunzNppPaytoPaymentMean"|"AunzBpayPaymentMean"|"AunzPostbillpayPaymentMean"|"AunzUriPaymentMean" - The type of payment means. Which type are returned is determined by the &pmv= query parameter. For details see documentation for that field
- account? string - The account number to which to transfer
- network? string - The payment network. Used only for type CardPaymentType
storecove: PurchaseInvoiceSender
Fields
- zip? string - The zip code
- country? string - The country
- city? string - The city
- billingContact? PurchaseInvoiceSenderBillingContact -
- identifiers? PeppolIdentifier[] - The array of identifiers for this sender
- county? string - The county
- peppolIdentifiers? PeppolIdentifier[] - DEPRECATED - Use the identifiers array
- secondaryNumber? string - The secondary number. Used in SA
- partyName? string - The party who sent the invoice
- legalName? string - The legal name of the party who sent the invoice
- neighborhood? string - The neighborhood. Used in SA
- department? string - The department who sent the invoice
- line2? string - The address, line 2
- line1? string - The address
- buildingNumber? string - The building number. Used in SA
storecove: PurchaseInvoiceSenderBillingContact
Fields
- lastName? string - The last name of the billing contact
- firstName? string - The first name of the billing contact
- email? string - The email of the billing contact
storecove: PurchaseInvoiceTax
Fields
- tax? PurchaseInvoiceTaxElement - The tax element
storecove: PurchaseInvoiceTaxElement
The tax element
Fields
- country? string - The tax country
- amount? decimal - The tax amount
- categoryCode? string - Deprecated. The tax category code
- percentage? decimal - The tax percentage
- category? "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" - The tax category
- 'type? "VAT"|"GST" - The tax type
storecove: PurchaseInvoiceTaxSubtotal
Fields
- vat? PurchaseInvoiceVat - DEPRECATED - Use tax
- amountExcludingTax? decimal - The amount excluding tax
- tax? PurchaseInvoiceTax -
- amountExcludingVat? string - DEPRECATED - use amount_excluding_tax
storecove: PurchaseInvoiceUbl
Fields
- legalEntityId? int - The id of the LegalEntity the invoice was received for
- systemGeneratedPrimaryImage? boolean - 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
- externalKey? string - Used for accountants. The id you specified for the organization
- guid? string - The GUID of the invoice
- taxSystem? string - 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
- ubl? string - The Base64 encoded UBL invoice
- externalUserId? string - Used for the embedded portal retrieval service. The external_user_id you provided when the ShopAccount was created
storecove: PurchaseInvoiceVat
DEPRECATED - Use tax
Fields
- amount? string - The VAT country
- percentage? string - The VAT percentage
storecove: RawDocumentData
A document to send, in base64 encoded format
Fields
- parseStrategy? "ubl"|"cii"|"idoc"|"setu14" - How to parse the document
- document string - The base64 encoded version of the document
- parse boolean(default true) - DEPRECATED. Will be ignored
storecove: ReaRegistration
Fields
- identifier? string - The identifier
- capital? decimal - The captial for the company
- province? "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" - The provincia of the ufficio that issued the identifier
- partners? "SU"|"SM" - The number of partners
- liquidationStatus? "LN"|"LS" - The liquidation status of the company
storecove: ReceivableDocument
The received document
Fields
- documentType "invoice"|"order" - The type of document received
- 'source "self"|"peppol"|"dbnalliance"|"ro-anaf"|"finvoice"|"it-sdi" - The source of the document
- invoice? Invoice - The invoice to send. Provide either invoice, or invoiceData, but not both
- 'order? DocumentOrder - The order to send
storecove: ReceivedDocument
Fields
- guid? string - The GUID of the received document
storecove: ReceivedDocumentCreate
Fields
- document string - The Base64 encoded document
- parseStrategy "rfc822" - The attachment content type (mime type)
storecove: Receiver
The receiver of the document
Fields
- government? GovernmentReceiver - The government receiver of the document
- business? BusinessReceiver - The business receiver of the document
- consumer? ConsumerReceiver - The consumer receiver of the document
storecove: Reference
A reference to a document
Fields
- documentDescription? string - A description for the referenced document
- documentType "purchase_order"|"replaced_order"|"buyer_reference"|"billing"|"billing_uuid"|"advance_invoice"|"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"|"line_billing"|"line_despatch_document"|"line_receipt_document" - The type of the referenced document. The following types are supported:
- documentUuid? string - The UUID of the referenced document
- documentIdListVersionId? string - The version id of the list id of the id of the referenced document
- documentIdListId? string - The list id of the id of the referenced document
- lineId? string - The line in the referenced document
- documentIdSchemeVersionId? string - The version id of the scheme id of the id of the referenced document
- documentIdSchemeId? string - The scheme id of the id of the referenced document
- documentIdSchemeAgencyId? string - The the agency id of the scheme id of the id of the referenced document
- documentIdListAgencyId? string - The agency id of the list id of the id of the referenced document
- documentTypeCode? string - The code of the referenced document type. Used for documentType = 'line_document_reference', and for the FR-FE extensions documentType = 'contract' (EXT-FR-FE-01, allowed values for FR-DGFiP: 'CONTRAT', 'MARCHE') and documentType = 'line_billing' (EXT-FR-FE-137). UNCL1001 codes may be sent either prefixed ('uncl1001_<code>') or as bare digits
- documentId? string - The id of the referenced document
- issueDate? string - The issue date of the referenced document
storecove: Routing
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
Fields
- emails? string[] - The email addresses the invoice should be sent to if none of the other identifiers can be used
- eIdentifiers? ElectronicIdentifiers - A list of electronic routing identifiers. These are the identifiers used on the Peppol network or for other destinations
- clearWithoutSending boolean(default false) - 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
- networks? RoutingNetwork[] - Any additional networks to consider for routing
storecove: RoutingIdentifier
An electronic routing identifier
Fields
- role? "es_01_fiscal"|"es_02_receptor"|"es_03_pagador" - The role of the identifier. Only used for B2G sending to ES
- scheme string - The scheme of the identifier. See <<_receiver_identifiers_list>> for a list
- id string - The actual identifier
storecove: RoutingNetwork
An additional network to consider for routing
Fields
- settings NetworkSettings - Settings for an additional routing network
- scheme? string - The name of the network
storecove: SalesAgentParty
An agent acting on behalf of the seller. Used in the French e-invoicing reform (FR-FE EXT-FR-FE-BG-03). Maps to UBL AccountingSupplierParty/Party/AgentParty and CII SalesAgentTradeParty
Fields
- publicIdentifiers? PublicIdentifier[] - A list of legal and tax identifiers for this party
- party Party - A party that can receive or send invoices
storecove: SellerSupplierParty
The party sending the order
Fields
- publicIdentifiers PublicIdentifier[] - A list of legal and tax identifiers for this customer
- party SenderParty - A party that can send documents
storecove: SendableDocument
The document to send
Fields
- invoiceReport? DocumentInvoiceReport - The invoice report to send. Reports a received invoice (forDocumentGuid) to the tax authority as a purchase, reusing the data of the received invoice.
- invoiceResponse? DocumentInvoiceResponse - The invoice response to send or received
- frEReport? FrEReport - E-reporting payload for France (DGFiP). Send with document.documentType "fr_e_report". The platform submits the report (FFE1025A) in the fr-dgfip workflow. Both camelCase frEReport and snake fr_e_report keys are accepted in the request body; the public schema uses frEReport. G6.29: exactly one of transactionReport (TB-2) or paymentReport (TB-3) must be present — not both, not neither (enforced at submission time; not expressible in OpenAPI 2.0). See also the France appendix in the API documentation
- documentType "enveloped_data"|"invoice"|"invoice_response"|"cdar"|"ppf_cdar"|"invoice_report"|"order"|"fr_e_report"|"payment_received_notification" - The type of document to be sent
- rawDocumentData? RawDocumentData - A document to send, in base64 encoded format
- invoice? Invoice - The invoice to send. Provide either invoice, or invoiceData, but not both
- paymentReceivedNotification? SendableDocumentPaymentReceivedNotification - A French payment received notification (lifecycle status 212 Encaissee). Provide the referenced invoice submission via the top-level forDocumentSubmissionGuid field. Use mode=auto when the invoice was paid in full: the per-VAT-rate breakdown is derived from the referenced invoice. Use mode=manual for a partial payment: you supply the amounts actually received per VAT rate, since only you know how the payment was allocated
- envelopedData? EnvelopedData - A document to send, in base64 encoded format, to be wrapped in an envelope
- 'order? DocumentOrder - The order to send
storecove: SendableDocumentPaymentReceivedNotification
A French payment received notification (lifecycle status 212 Encaissee). Provide the referenced invoice submission via the top-level forDocumentSubmissionGuid field. Use mode=auto when the invoice was paid in full: the per-VAT-rate breakdown is derived from the referenced invoice. Use mode=manual for a partial payment: you supply the amounts actually received per VAT rate, since only you know how the payment was allocated
Fields
- mode "auto"|"manual" - auto: report the full invoiced amount, split per VAT rate from the referenced invoice. manual: report the taxSubtotals provided here
- taxSubtotals? PaymentTaxSubtotal[] - Only for mode=manual, where it is mandatory, and rejected with mode=auto. One entry per VAT rate the payment is allocated to. The sum of the amountIncludingVat may not exceed the total of the referenced invoice, nor, per VAT rate, what that invoice has at the rate. Each notification is checked on its own: what earlier notifications reported for the same invoice is not added up, so it is up to the sender not to report more than the invoice total overall
- currency? CurrencyCode - The ISO 4217 currency code
- paymentDate? string - Only for mode=manual, and rejected with mode=auto. The date the payment was received, used as the date of the 212 status. Format: yyyy-mm-dd. It may precede the invoice (a down payment) but not be in the future. Defaults to the submission date
storecove: Sender
The sender of the document
Fields
- legal? CountrySpecificationIdentifier -
storecove: SenderParty
A party that can send documents
Fields
- contact? Contact - Contact details for the invoice
storecove: Shipment
Fields
- allowanceCharges? AllowanceCharge[] - A list of charges
- shippingMarks? string - A text that the buyer requests to be printed on the packing labels. Used only for DocumentOrder
- originAddress? Address - The address
storecove: Tax
Fields
- country Country - An ISO 3166-1 alpha-2 country code
- amount? decimal - 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
- percentage? decimal - 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'
- acknowledgeThirdCountryTax boolean(default false) - When specifying a tax country other than that of the sender or the receiver, this flag must be set. This is to prevent accidental errors
- category? "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"|"sales_exempt"|"service_exempt"|"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" - The allowed values depend on the country of the tax:
- 'type? "VAT"|"GST" - 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
storecove: TaxAuthority
Information relating to a tax authority
Fields
- uuid? string - The uuid assigned by the tax authority upon validation
- uri? string - A URI (deep link) to the document with the tax authority
- validatedAt? string - The datetime when the document was validated by the tax authority
storecove: TaxSubtotal
The total amount of tax of this type in the invoice
Fields
- taxableAmount? decimal - The amount on which the tax is levied. For Malaysian LHDNM sales_exempt and service_exempt categories, this is the Amount Exempted from Tax
- country Country - An ISO 3166-1 alpha-2 country code
- taxExemptionReasonCode? string - The VAT exemption reason code for this tax subtotal. For Peppol BIS Billing 3.0 this should be a valid VATEX code
- percentage? decimal - The tax percentage. This should be a valid tax percentage in the country at the time of the taxpointDate of this invoice
- taxExemptionReason? string - The VAT exemption reason text for this tax subtotal. For Malaysian LHDNM, this is the Details of Tax Exemption (for example the buyer's SST exemption certificate number or a gazette order) and is mandatory when tax exemption applies
- taxAmount decimal - The amount of tax
- category? "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"|"sales_exempt"|"service_exempt"|"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" - The tax category. For a description see <<_openapi_tax>>
storecove: Transportable
A transportable document. Currently only used for receiving
Fields
- original? string - The document as originally received. Process this as a blob. Only present if requested
- legalEntityId? int - The id of the LegalEntity this document should be sent on behalf of or was received for
- document? ReceivableDocument - The received document
- guid? string - The GUID of the document that was received
- direction? "in"|"out" - The direction of the document
storecove: VATDetails
DEPRECATED - use tax. The VAT details for the invoice line
Fields
- country? string - The ISO 3166 country of the VAT for the invoice line
- amount? decimal - The amount of VAT for the invoice line
- percentage? decimal - The percentage of VAT for the invoice line
storecove: WebhookInstance
Fields
- guid? string - The GUID of the WebhookInstance. Use this to delete it
- body? string - The webhook body that would have been pushed if this were a push-mode webhook
Union types
storecove: CurrencyCode
CurrencyCode
The ISO 4217 currency code
storecove: Country
Country
An ISO 3166-1 alpha-2 country code
Array types
storecove: PublicIdentifiers
PublicIdentifiers
A list of public identifiers that uniquely identify this customer
storecove: ElectronicIdentifiers
ElectronicIdentifiers
A list of electronic routing identifiers. These are the identifiers used on the Peppol network or for other destinations
String types
storecove: OrderLineLotNumberIdsItemsString
OrderLineLotNumberIdsItemsString
Simple name reference types
storecove: ReceiverParty
ReceiverParty
A party that can receive or send invoices
storecove: PriceAllowanceCharges
PriceAllowanceCharges
Import
import ballerinax/storecove;Metadata
Released date: about 16 hours ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 47
Current verison: 1
Weekly downloads
Keywords
Vendor/Storecove
Area/Finance & Accounting
Type/Connector
Contributors