Approve postpaid invoice

The Approve postpaid invoice method is used for approving a postpaid invoice in the platform with a third-party invoice issued to an account of the reseller by a third-party ERP system (see Managing invoices for the Postpay model by a third-party ERP system). As a result:

Optionally, the third-party ERP system can attach to the payment linked to the postpaid invoice a receipt as a file or a link.
The platform sets the due date for the payment according to the account class of the account.

For accounts with several invoices within the same billing period, use another API method and specify the ID of the required invoice — see Approve postpaid invoice by ID.

The platform matches a third-party invoice and invoice for the Postpay model using the start date of the billing period.

An API token of a manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating manager's information.

The manager's API token specified in an API request determines the current reseller and downstream resellers accessible within a method.

POST {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/approve_invoices

Arguments

Name		Parameter Type	Data type	Required/Optional	Description
X-Api-Token		header	string	Required	API token of a manager that performs the operation (see Viewing and updating manager's information)
Content-Type		header	string	Required	Media type of the request. Specify the following: application/vnd.api+json
Accept		header	string	Required	Supported media types of the answer. Specify the following: application/vnd.api+json
base_url		path	string	Required	ActivePlatform URL
reseller_id		path	number	Required	ID of the current reseller or any of its downstream resellers (see Viewing and updating reseller general information)
account_id		path	number	Required	Account ID
document_id		form	string	Required	Third-party invoice name
billing_date		form	string	Required	Start date (YYYY-MM-DD) of the billing period for which the invoice is issued (calculated, not stored in the platform)
file		form	object	Optional	Data about a third-party invoice file issued by an ERP system. It is possible to specify a file or a link to the file but not both
	data	form	string	Optional	Third-party invoice file in the base64 encoding. Required if the data about a third-party invoice file is specified The maximum file size is defined by the settings of the given installation of the platform. To change the limit, please contact the support team.
	name	form	string	Optional	Third-party invoice file name. Required if the data about a third-party invoice file is specified
link		form	object	Optional	Data about a link to a third-party invoice file issued by an ERP system. It is possible to specify a file or a link to the file but not both
	data	form	string	Optional	Link to a third-party invoice file. Required if the data about a link to a third-party invoice file is specified
	name	form	string	Optional	Third-party invoice file in the link. Required if the data about a link to a third-party invoice file is specified

Response model

Name			Data type	Description
data			object	Response data
	id		string	Invoice ID in the platform
	type		string	Data type
	attributes		object	Postpaid invoice information
		created_at	string	Date and time of invoice creation
		updated_at	string	Data and time of invoice last update
		document_id	string	Invoice number
		status	string	Invoice status
		total	float	Invoice total
		account_id	integer	ID of the account for which the invoice was issued
		from_date	date	Start date of the period covered by the invoice
		to_date	date	End date of the period covered by the invoice
		payment_model	string	Invoice payment model: postpay

Errors

Status	Error code	Error text	Comment
400	INVOICE-0001	Required parameters are not provided	Specify all required parameters in the request
404	INVOICE-0002	Invoice for billing date {billing_date} was not found for account id {account_id}	The account does not have an invoice for the specified start date of the billing period. An invoice for the specified start date of the billing period has the total amount equal to 0. The invoice cannot be approved because it does not have information about the linked subscriptions.
422	INVOICE-0003	Unable to approve invoice one more time	The invoice is already approved
422		Only one attribute can be present: file or link	It is possible to specify a file or a link to the file but not both

Request example

POST /api/v3/resellers/1/accounts/505/approve_invoices
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

{
    "document_id": "NS2000015",
    "billing_date": "2020-04-01",
    "file": {
        "data": "data:application/pdf;base64,'SSBob2xkIHRoZSBwb3NpdGlvbiBvZiBhIHFhIGVuZ2luZWVyLiBRQSBlbmdpbmVlciByZXNwb25zaWJpbGl0aWVzIGluY2x1ZGUgZGVzaWduaW5nIGFuZCBpbXBsZW1lbnRpbmcgdGVzdHMsIGRlYnVnZ2luZyBhbmQgZGVmaW5pbmcgY29ycmVjdGl2ZSBhY3Rpb25zLiBJIGFsc28gcmV2aWV3IHN5c3RlbSByZXF1aXJlbWVudHMgYW5kIHRyYWNrIHF1YWxpdHkgYXNzdXJhbmNlIG1ldHJpY3MgKGUuZy4gZGVmZWN0IGRlbnNpdGllcyBhbmQgb3BlbiBkZWZlY3QgY291bnRzLikgVGhlIFFBIHRlY2huaWNpYW4gcm9sZSBwbGF5cyBhbiBpbXBvcnRhbnQgcGFydCBpbiBvdXIgY29tcGFueeKAmXMgcHJvZHVjdCBkZXZlbG9wbWVudCBwcm9jZXNzLg=='",
        "name": "Invoice NS2000015"
    }
}

Response example

{
    "data": {
        "id": "2046",
        "type": "invoices",
        "attributes": {
            "created_at": "2019-04-18T09:02:01.257560+0300",
            "updated_at": "2019-05-02T06:12:41.990713+0300",
            "document_id": "NS2000015",
            "status": "closed",
            "total": "0.32",
            "account_id": 505,
            "from_date": "2019-04-17",
            "to_date": "2019-05-01",
            "payment_model": "postpay"
        }
    }
}