Technical
description scope-rest-webservices
Tax Authority API
Purpose
The Tax Authority API offers endpoints for submitting invoice registration results for accounts receivables to local tax authorities in Scope. It enables updating the invoice status from “Finalization Pending” to “Finished” upon acceptance by the tax authorities or to “Rejected” if the submission is declined.
Acceptance
If the tax authority accepts the accounts receivable invoice, an HTTP-POST request to the endpoint “finance/v1/accountsreceivable/{invoiceID}/acceptances” creates an acceptance in Scope, which sets the status of the accounts receivable to “Finished”. Further optional information like
- an invoice-Identifier from the tax authority
- a base64-encoded signedInvoice.xml
- a base64-encoded detachedSignature.xml
can be attached to the request. The files are stored in Scope and attached to the document tab of the accounts receivable.
Rejection
If the tax authority rejects the accounts receivable, an HTTP-POST request to the endpoint “finance/v1/accountsreceivable/{invoiceID}/rejections” creates a new rejection in Scope, which sets the status of the accounts receivable to “Rejected”. A mandatory reason has to be provided in the request, which is stored and can be seen as “rejection reason” in the accounts receivable in Scope.
API documentation
The API is documented using an OpenAPI specification, enabling tools like Swagger to visualize the API and generate code in multiple programming languages.
Version 1: accountsreceivables-api-1.0.json