Complete postpaid invoice

The Complete postpaid invoice method is used for approving the payment linked to an approved postpaid invoice (see Approve postpaid invoice) 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).

For accounts with several invoices within the same billing period, use another API method and specify the ID of the required invoice — see Complete 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}/complete_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)

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. A payment for the invoice cannot be approved because the invoice does not have information about the linked subscriptions.
422	INVOICE-0004	Unable to complete invoice one more time	The invoice is already completed

Request example

POST /api/v3/resellers/1/accounts/505/complete_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"
}

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"
        }
    }
}