@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Storecove API
@base https://api.storecove.com/api/v2
@version 2.0.1
@auth ApiKey Authorization in header
@endpoints 37
@hint download_for_search
@toc invoice_submissions(3), document_submissions(2), legal_entities(15), purchase_invoices(3), webhook_instances(2), discovery(3), received_documents(1), api(8)

@group invoice_submissions
@endpoint GET /invoice_submissions/{guid}/evidence
@required {guid: any}
@returns(200)
@errors {401, 403, 404}

@endpoint POST /invoice_submissions
@required {invoice_submission: map}
@returns(200)
@errors {401, 403, 422}

@endgroup

@group document_submissions
@endpoint POST /document_submissions
@required {document_submission: map}
@returns(200)
@errors {401, 403, 422}

@endpoint GET /document_submissions/{guid}/evidence/{evidence_type}
@required {guid: any}
@optional {evidence_type: any}
@returns(200)
@errors {401, 403, 404}

@endgroup

@group invoice_submissions
@endpoint POST /invoice_submissions/preflight
@required {invoice_recipient_preflight: map}
@returns(200)
@errors {401, 403, 422}

@endgroup

@group legal_entities
@endpoint POST /legal_entities
@required {legal_entity: any}
@returns(200)
@errors {401, 403, 422}

@endpoint GET /legal_entities/{id}
@required {id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint DELETE /legal_entities/{id}
@required {id: any}
@returns(204)
@errors {401, 403, 404}

@endpoint PATCH /legal_entities/{id}
@required {id: any, legal_entity: any}
@returns(200)
@errors {401, 403, 404, 422}

@endpoint POST /legal_entities/{legal_entity_id}/peppol_identifiers
@required {legal_entity_id: any, peppol_identifier: any}
@returns(200)
@errors {401, 403, 404, 422}

@endpoint DELETE /legal_entities/{legal_entity_id}/peppol_identifiers/{superscheme}/{scheme}/{identifier}
@required {legal_entity_id: any, superscheme: any, scheme: any, identifier: any}
@returns(204)
@errors {401, 403, 404}

@endpoint POST /legal_entities/{legal_entity_id}/administrations
@required {legal_entity_id: any, administration: any}
@returns(200)
@errors {401, 403, 404, 422}

@endpoint GET /legal_entities/{legal_entity_id}/administrations/{id}
@required {legal_entity_id: any, id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint DELETE /legal_entities/{legal_entity_id}/administrations/{id}
@required {legal_entity_id: any, id: any}
@returns(204)
@errors {401, 403, 404}

@endpoint PATCH /legal_entities/{legal_entity_id}/administrations/{id}
@required {legal_entity_id: any, id: any, administration: any}
@returns(200)
@errors {401, 403, 404}

@endpoint POST /legal_entities/{legal_entity_id}/additional_tax_identifiers
@required {legal_entity_id: any, additional_tax_identifier: any}
@returns(200)
@errors {401, 403, 404, 422}

@endpoint GET /legal_entities/{legal_entity_id}/additional_tax_identifiers/{id}
@required {legal_entity_id: any, id: any}
@returns(200)
@errors {401, 403, 404}

@endpoint DELETE /legal_entities/{legal_entity_id}/additional_tax_identifiers/{id}
@required {legal_entity_id: any, id: any}
@returns(204)
@errors {401, 403, 404}

@endpoint PATCH /legal_entities/{legal_entity_id}/additional_tax_identifiers/{id}
@required {legal_entity_id: any, id: any, additional_tax_identifier: any}
@returns(200)
@errors {401, 403, 404}

@endgroup

@group purchase_invoices
@endpoint GET /purchase_invoices/{guid}
@required {guid: any}
@optional {pmv: any, version: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /purchase_invoices/{guid}/{packaging}
@required {guid: any, packaging: any}
@optional {pmv: any, version: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /purchase_invoices/{guid}/{packaging}/{package_version}
@required {guid: any, packaging: any, package_version: any}
@returns(200)
@errors {401, 403, 404}

@endgroup

@group webhook_instances
@endpoint GET /webhook_instances/
@returns(200)
@returns(204)
@errors {401, 403, 404}

@endpoint DELETE /webhook_instances/{guid}
@required {guid: any}
@returns(204)
@errors {401, 403, 404}

@endgroup

@group discovery
@endpoint POST /discovery/receives
@required {discoverable_participant: map}
@returns(200)
@errors {401, 403, 422}

@endpoint POST /discovery/exists
@required {discoverable_participant: map}
@returns(200)
@errors {401, 403, 422}

@endpoint GET /discovery/identifiers
@returns(200)
@errors {401, 403}

@endgroup

@group legal_entities
@endpoint POST /legal_entities/{legal_entity_id}/received_documents
@required {legal_entity_id: any, received_document: any}
@returns(200)
@errors {401, 403, 404, 422}

@endgroup

@group received_documents
@endpoint GET /received_documents/{guid}/{format}
@required {guid: any}
@optional {format: any, version: any}
@returns(200)
@errors {400, 401, 403, 404}

@endgroup

@group api
@endpoint POST /api/v2/legal_entities/{legal_entity_id}/c5/iras/email/activate
@required {legal_entity_id: any, c5_email_request: map}
@returns(204)
@errors {401, 403, 404, 422}

@endpoint POST /api/v2/legal_entities/{legal_entity_id}/c5/iras/email/deactivate
@required {legal_entity_id: any, c5_email_request: map}
@returns(204)
@errors {401, 403, 404, 422}

@endpoint PUT /api/v2/legal_entities/{legal_entity_id}/c5/iras/email/cancel
@required {legal_entity_id: any, c5_email_cancellation_request: map}
@returns(204)
@errors {422}

@endpoint POST /api/v2/legal_entities/{legal_entity_id}/c5/iras/redirect/activate
@required {legal_entity_id: any, c5_redirect_request: map}
@returns(200)
@errors {401, 403, 404, 422}

@endpoint POST /api/v2/legal_entities/{legal_entity_id}/c5/iras/redirect/deactivate
@required {legal_entity_id: any, c5_redirect_request: map}
@returns(200)
@errors {401, 403, 404, 422}

@endpoint PUT /api/v2/legal_entities/{legal_entity_id}/c5/iras/redirect/cancel
@required {legal_entity_id: any, c5_redirect_cancellation_request: map}
@returns(204)
@errors {422}

@endpoint POST /api/v2/legal_entities/{legal_entity_id}/c5_activation/activate
@required {legal_entity_id: any, c5_activation_request: map}
@returns(200)
@errors {401, 403, 404, 422}

@endpoint POST /api/v2/legal_entities/{legal_entity_id}/c5_deactivation/deactivate
@required {legal_entity_id: any, c5_deactivation_request: map}
@returns(200)
@errors {401, 403, 404, 422}

@endgroup

@end