README

This PHP package is automatically generated by the Swagger Codegen project:

API version: 0.85.122
Build package: io.swagger.codegen.languages.PhpClientCodegen

java -jar swagger-codegen-cli.jar generate -i https://ax.maventa.com/swagger_doc -l php -DvariableNamingConvention=camelCase --invoker-package=Vertaislaina\\Maventa\\AutoXChange --git-user-id=vertaislaina --git-repo-id=maventa-autoxchange -DapiTests=false -DmodelTests=false -DsrcBasePath=src --model-package=Entity -DpackagePath=.

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/vertaislaina/maventa-autoxchange.git"
    }
  ],
  "require": {
    "vertaislaina/maventa-autoxchange": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/./vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Vertaislaina\Maventa\AutoXChange\Api\AnalysisApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$checks = array("checks_example"); // string[] | Filter definitions by checks. Possible values:  SUPPLIER_ACTIVATION, SENDER_BID_STATUS, SENDER_WARNING_LIST, VAT
$checkAttributes = array("checkAttributes_example"); // string[] | Filter only definitions of interest. Possible values:  name, friendly_name, friendly_names, title, titles, description, descriptions, doc_description, resource_type, scope, scopes, sources, metadata, possible_results

try {
    $result = $apiInstance->getV1AnalysisDefinitions($checks, $checkAttributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalysisApi->getV1AnalysisDefinitions: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://ax.maventa.com

Class	Method	HTTP request	Description
AnalysisApi	getV1AnalysisDefinitions	GET /v1/analysis/definitions
AnalysisApi	getV1AnalysisId	GET /v1/analysis/{id}
AnalysisApi	postV1Analysis	POST /v1/analysis	Trigger analysis for resource
CompanyApi	deleteV1CompanyNotificationsId	DELETE /v1/company/notifications/{id}	Delete a specific notification subscription
CompanyApi	deleteV1CompanyProfilesId	DELETE /v1/company/profiles/{id}	Delete a network registration
CompanyApi	getV1CompanyConsumers	GET /v1/company/consumers	List B2CNO Consumers
CompanyApi	getV1CompanyNotifications	GET /v1/company/notifications	List notification subscriptions
CompanyApi	getV1CompanyNotificationsId	GET /v1/company/notifications/{id}	Fetch a specific notification subscription
CompanyApi	getV1CompanyProfiles	GET /v1/company/profiles	List network registrations
CompanyApi	getV1CompanyProfilesId	GET /v1/company/profiles/{id}	Fetch a network registration
CompanyApi	getV1CompanySettings	GET /v1/company/settings	Fetch company settings
CompanyApi	patchV1CompanyProfilesId	PATCH /v1/company/profiles/{id}	Update a network registration
CompanyApi	patchV1CompanySettings	PATCH /v1/company/settings	Modify company settings
CompanyApi	postV1CompanyNotifications	POST /v1/company/notifications	Create new notification subscription
CompanyApi	postV1CompanyProfiles	POST /v1/company/profiles	Create network registration request
DocumentsApi	getV1Documents	GET /v1/documents	Query documents
DocumentsApi	getV1DocumentsId	GET /v1/documents/{id}
DocumentsApi	getV1DocumentsIdEvents	GET /v1/documents/{id}/events
DocumentsApi	patchV1DocumentsId	PATCH /v1/documents/{id}
DocumentsApi	postV1Documents	POST /v1/documents
FilesApi	getV1Files	GET /v1/files
FilesApi	getV1FilesId	GET /v1/files/{id}
InvoicesApi	deleteV1InvoicesIdReportsReportId	DELETE /v1/invoices/{id}/reports/{report_id}
InvoicesApi	getV1Invoices	GET /v1/invoices	List invoices
InvoicesApi	getV1InvoicesId	GET /v1/invoices/{id}	Invoice details
InvoicesApi	getV1InvoicesIdActions	GET /v1/invoices/{id}/actions	List invoice actions
InvoicesApi	getV1InvoicesIdFilesFileId	GET /v1/invoices/{id}/files/{file_id}	Fetch file content
InvoicesApi	getV1InvoicesIdReports	GET /v1/invoices/{id}/reports
InvoicesApi	postV1Invoices	POST /v1/invoices	Upload new invoice
InvoicesApi	postV1InvoicesIdReports	POST /v1/invoices/{id}/reports
InvoicesApi	putV1InvoicesIdRerouteEinvoice	PUT /v1/invoices/{id}/reroute/einvoice
InvoicesApi	putV1InvoicesIdRerouteEmail	PUT /v1/invoices/{id}/reroute/email
InvoicesApi	putV1InvoicesIdReroutePrint	PUT /v1/invoices/{id}/reroute/print
JwkApi	getV1Jwk	GET /v1/jwk
LookupApi	getV1LookupConsumers	GET /v1/lookup/consumers	Lookup for consumer recipients
LookupApi	getV1LookupEndpoints	GET /v1/lookup/endpoints
LookupApi	getV1LookupReceivers	GET /v1/lookup/receivers
Oauth2Api	getOauth2Current	GET /oauth2/current	Fetch information about the authenticated user and company
Oauth2Api	postOauth2Token	POST /oauth2/token	OAuth2 token endpoint
OdpApi	getOdpCompaniesId	GET /odp/companies/{id}
OdpApi	patchOdpCompaniesId	PATCH /odp/companies/{id}
OperatorApi	deleteV1OperatorNotificationsId	DELETE /v1/operator/notifications/{id}
OperatorApi	deleteV1OperatorParticipantsId	DELETE /v1/operator/participants/{id}
OperatorApi	getV1OperatorCompanies	GET /v1/operator/companies
OperatorApi	getV1OperatorNotifications	GET /v1/operator/notifications
OperatorApi	getV1OperatorNotificationsId	GET /v1/operator/notifications/{id}
OperatorApi	getV1OperatorParticipants	GET /v1/operator/participants
OperatorApi	getV1OperatorParticipantsId	GET /v1/operator/participants/{id}
OperatorApi	patchV1OperatorParticipantsId	PATCH /v1/operator/participants/{id}
OperatorApi	postV1OperatorNotifications	POST /v1/operator/notifications
OperatorApi	postV1OperatorParticipants	POST /v1/operator/participants
ServicesApi	deleteV1ServicesReceivables	DELETE /v1/services/receivables	Disable the Receivables service
ServicesApi	getV1ServicesAtg	GET /v1/services/atg	List ATG agreements
ServicesApi	getV1ServicesAtgAccountNumber	GET /v1/services/atg/{account_number}	Fetch ATG agreement
ServicesApi	getV1ServicesAtgMandates	GET /v1/services/atg/mandates	List B2C ATG mandates
ServicesApi	getV1ServicesB2cnoConsumers	GET /v1/services/b2cno/consumers	List B2CNO Consumers
ServicesApi	getV1ServicesOpInvoiceCredit	GET /v1/services/op_invoice_credit	Current information about the OP Laskulaina service
ServicesApi	getV1ServicesOpInvoiceCreditAccountStatement	GET /v1/services/op_invoice_credit/account_statement	Fetch account statement
ServicesApi	getV1ServicesOpInvoiceCreditAvailableCredit	GET /v1/services/op_invoice_credit/available_credit	Check the credit balance
ServicesApi	getV1ServicesReceivables	GET /v1/services/receivables	Current state of the receivables service
ServicesApi	patchV1ServicesAtgAccountNumber	PATCH /v1/services/atg/{account_number}	Update existing ATG agreement
ServicesApi	postV1ServicesAtg	POST /v1/services/atg	Create a new ATG agreement
ServicesApi	postV1ServicesOpInvoiceCreditWithdrawal	POST /v1/services/op_invoice_credit/withdrawal	Make a withdrawal
ServicesApi	putV1ServicesOpInvoiceCredit	PUT /v1/services/op_invoice_credit	Start the OP Laskulaina onboarding
ServicesApi	putV1ServicesReceivables	PUT /v1/services/receivables	Start the Receivables service onboarding
StatusApi	getStatusAuthenticated	GET /status/authenticated	Status requiring authentication

Documentation For Models

Documentation For Authorization

company_auth

Type: OAuth
Flow: application
Authorization URL:
Scopes:
eui: Recommended to use when integrating to EUI. Alias for eui:open, company:read, company:write, lookup, receivables:assignments, document:send, document:receive, invoice:receive, invoice:send, analysis
global: Alias for company:read, document:receive, document:send, lookup
company: Alias for company:read, company:write
lookup: grants access to the lookup operations
document:receive: grants access to document receive operations
document:send: grants access to document send operations
invoice:receive: grants access to invoice receive operations
invoice:send: grants access to invoice send operations
company:read: grants read access to company settings, profiles and notifications
company:write: grants write access to company settings, profiles and notifications
validate: grants access to the AutoInvoice validator service
receivables:assignments: grants access to assignments in the receivables service
analysis: grants access to analysis service
billing:reports: grants access to billing reports

operator_auth

Type: OAuth
Flow: application
Authorization URL:
Scopes:
operator:documents:receive: grants access to fetch received documents
operator:documents:send: grants access to send documents
operator:lookup: grants access to perform actions related to lookups
operator:participants: grants access to perform actions on operator participants
operator:notifications: grants access to perform actions on operator notifications
operator:validate: grants access to the AutoInvoice validator service
operator:receivables:assignments: grants access to assignments the receivables service
operator:receivables:assignments:create: grants access to create assignments in the receivables servicee
operator:analysis: grants access to analysis service
operator:companies: grants access to fetch operator companies
operator:takeover: grants access to execute a company takeover

vertaislaina / maventa-autoxchange

Maintainers

Details