Skip to content

PaymentApi.md

Latest commit

 

History

History
347 lines (254 loc) · 13.2 KB

PaymentApi.md

File metadata and controls

347 lines (254 loc) · 13.2 KB

SynergiTech\Iplicit\PaymentApi

All URIs are relative to https://api.iplicit.com, except if the operation defines another base path.

Method HTTP request Description
addPaymentAllocation() POST /api/Payment/{docIdOrCode}/allocation Add a payment allocation.
createPayment() POST /api/Payment Create a payment.
getPayment() GET /api/Payment/{id} Get a payment
getPayments() GET /api/Payment Get a list of payments with a search filter
submitPayment() POST /api/Payment/{id}/submit Submit the payment for authorisation and posting.

addPaymentAllocation()

addPaymentAllocation($docIdOrCode, $docAllocationCreate): string

Add a payment allocation.

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\PaymentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$docIdOrCode = 'docIdOrCode_example'; // string | Id or document number of the payment
$docAllocationCreate = new \SynergiTech\Iplicit\Model\DocAllocationCreate(); // \SynergiTech\Iplicit\Model\DocAllocationCreate

try {
    $result = $apiInstance->addPaymentAllocation($docIdOrCode, $docAllocationCreate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentApi->addPaymentAllocation: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
docIdOrCode string Id or document number of the payment
docAllocationCreate \SynergiTech\Iplicit\Model\DocAllocationCreate [optional]

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createPayment()

createPayment($docCreate): string

Create a payment.

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\PaymentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$docCreate = new \SynergiTech\Iplicit\Model\DocCreate(); // \SynergiTech\Iplicit\Model\DocCreate

try {
    $result = $apiInstance->createPayment($docCreate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentApi->createPayment: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
docCreate \SynergiTech\Iplicit\Model\DocCreate [optional]

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPayment()

getPayment($id, $include): \SynergiTech\Iplicit\Model\Doc

Get a payment

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\PaymentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$id = 'id_example'; // string | Id or document number of the payment
$include = 'include_example'; // string | Comma separated list of details to include: `details`, `payments`, `tax`, `allocations`.

try {
    $result = $apiInstance->getPayment($id, $include);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentApi->getPayment: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string Id or document number of the payment
include string Comma separated list of details to include: `details`, `payments`, `tax`, `allocations`. [optional]

Return type

\SynergiTech\Iplicit\Model\Doc

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPayments()

getPayments($docNo, $docType, $docTypeId, $contactAccount, $contactAccountId, $legalEntity, $legalEntityId, $currency, $project, $projectId, $description, $descriptionContains, $theirRef, $intRef, $legacyRef, $theirDocNo, $docClass, $docDateFrom, $docDateTo, $dueDateFrom, $dueDateTo, $lastModifiedFrom, $lastModifiedTo, $outstanding, $unmatched, $draft, $abandoned, $posted, $approved, $reversed, $take, $skip): \SynergiTech\Iplicit\Model\DocSummary[]

Get a list of payments with a search filter

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\PaymentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$docNo = 'docNo_example'; // string | The document number
$docType = 'docType_example'; // string | The document type code
$docTypeId = 'docTypeId_example'; // string | The document type id
$contactAccount = 'contactAccount_example'; // string | The document contact account code
$contactAccountId = 'contactAccountId_example'; // string | The document contact account id
$legalEntity = 'legalEntity_example'; // string | The document legal entity code
$legalEntityId = 'legalEntityId_example'; // string | The document legal entity id
$currency = 'currency_example'; // string | The document currency
$project = 'project_example'; // string | The document project code
$projectId = 'projectId_example'; // string | The document project id
$description = 'description_example'; // string | The document description
$descriptionContains = 'descriptionContains_example'; // string | The document description contains
$theirRef = 'theirRef_example'; // string | An external reference code
$intRef = 'intRef_example'; // string | Optional interface reference. If provided, it must be unique. <a href=\"https://docs.iplicit.com/dev/guide/identifiers/index.html\">Learn more</a>
$legacyRef = 'legacyRef_example'; // string | Alternative / legacy reference code
$theirDocNo = 'theirDocNo_example'; // string | An external document number
$docClass = new \SynergiTech\Iplicit\Model\DocClass(); // DocClass | The document class
$docDateFrom = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The document from date
$docDateTo = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The document to date
$dueDateFrom = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The document due from date
$dueDateTo = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The document due to date
$lastModifiedFrom = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The document last modified from date
$lastModifiedTo = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The document last modified to date
$outstanding = True; // bool | The document outstanding flag
$unmatched = True; // bool | The document unmatched flag
$draft = True; // bool | The document draft flag
$abandoned = True; // bool | The document abandoned flag
$posted = True; // bool | The document posted
$approved = True; // bool | The document approved flag
$reversed = True; // bool | The document reversed flag
$take = 56; // int | The number of documents to take
$skip = 56; // int | The number of documents to skip

try {
    $result = $apiInstance->getPayments($docNo, $docType, $docTypeId, $contactAccount, $contactAccountId, $legalEntity, $legalEntityId, $currency, $project, $projectId, $description, $descriptionContains, $theirRef, $intRef, $legacyRef, $theirDocNo, $docClass, $docDateFrom, $docDateTo, $dueDateFrom, $dueDateTo, $lastModifiedFrom, $lastModifiedTo, $outstanding, $unmatched, $draft, $abandoned, $posted, $approved, $reversed, $take, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentApi->getPayments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
docNo string The document number [optional]
docType string The document type code [optional]
docTypeId string The document type id [optional]
contactAccount string The document contact account code [optional]
contactAccountId string The document contact account id [optional]
legalEntity string The document legal entity code [optional]
legalEntityId string The document legal entity id [optional]
currency string The document currency [optional]
project string The document project code [optional]
projectId string The document project id [optional]
description string The document description [optional]
descriptionContains string The document description contains [optional]
theirRef string An external reference code [optional]
intRef string Optional interface reference. If provided, it must be unique. <a href=&quot;https://docs.iplicit.com/dev/guide/identifiers/index.html\&quot;&gt;Learn more</a> [optional]
legacyRef string Alternative / legacy reference code [optional]
theirDocNo string An external document number [optional]
docClass DocClass The document class [optional]
docDateFrom \DateTime The document from date [optional]
docDateTo \DateTime The document to date [optional]
dueDateFrom \DateTime The document due from date [optional]
dueDateTo \DateTime The document due to date [optional]
lastModifiedFrom \DateTime The document last modified from date [optional]
lastModifiedTo \DateTime The document last modified to date [optional]
outstanding bool The document outstanding flag [optional]
unmatched bool The document unmatched flag [optional]
draft bool The document draft flag [optional]
abandoned bool The document abandoned flag [optional]
posted bool The document posted [optional]
approved bool The document approved flag [optional]
reversed bool The document reversed flag [optional]
take int The number of documents to take [optional]
skip int The number of documents to skip [optional]

Return type

\SynergiTech\Iplicit\Model\DocSummary[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

submitPayment()

submitPayment($id)

Submit the payment for authorisation and posting.

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\PaymentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$id = 'id_example'; // string | Id or document number of the payment

try {
    $apiInstance->submitPayment($id);
} catch (Exception $e) {
    echo 'Exception when calling PaymentApi->submitPayment: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string Id or document number of the payment

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]