Retrieve partner invoice
Overview
Access information about partner invoices in the Avangate system based on their unique references.
Requirements
This method requires you to set a specific partner using setPartner.
Parameters
Parameters | Type/Description |
---|---|
sessionID | Required (String) |
Session identifier, output of the Login method. An exception is thrown if the values are incorrect. | |
proformaNumber | Required (String) |
The unique identifier of a partner invoice from the Avangate system. |
Response
Parameters | Type/Description | |
---|---|---|
Proforma |
Object |
|
|
A partner invoice object with the structure detailed below. |
|
|
Number |
String |
|
|
Unique partner invoice identifier |
|
CreateDate |
String |
|
|
Partner invoice creation date |
|
DueDate |
String |
|
|
The date before which the partner needs to pay the invoice. |
|
Status |
String |
|
|
Partner invoice status. Possible values:
|
|
Currency |
String |
|
|
Partner invoice currency ISO code |
|
Total |
String |
|
|
Total costs of all orders included in the partner invoice |
|
PaymentMethod |
String |
|
|
Payment method used to pay for the partner invoice. NULL if the invoice was not paid. |
|
Orders |
String / Array |
|
|
Order references array of strings. A partner invoice only groups approved orders with the same currency. |
|
BusinessModel |
String |
|
|
The business model governing the relationship between you and the partner company. Possible values:
|
|
ProformaPDF |
String |
|
|
Partner invoice PDF download link. Valid for 1 hour. |
Request
<?php require ('PATH_TO_AUTH'); // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/02Authentication require ('PATH_TO_SET_PARTNER'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/06Reference/Partner/00Set_partner $proformaNumber = 'YOUR_PROFORMA_NUMBER'; $jsonRpcRequest = array ( 'jsonrpc' => '2.0', 'id' => $i++, 'method' => 'getProforma', 'params' => array($sessionID, $proformaNumber) ); var_dump (callRPC((Object)$jsonRpcRequest,$host));
Errors
Error | Description |
---|---|
INVALID_PARTNER |
No partner is set. |
INVALID_PROFORMA_NUMBER |
Invalid partner invoice number. |