Skip to content

README.md

Latest commit

 

History

History
458 lines (327 loc) · 20.5 KB

README.md

File metadata and controls

458 lines (327 loc) · 20.5 KB

Reconciliation.V1

Overview

Available Operations

createPolicy

Create a policy

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Reconciliation;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new \formance\stack\Models\Reconciliation\PolicyRequest(
    ledgerName: 'default',
    ledgerQuery: [
        'key' => '<value>',
    ],
    name: 'XXX',
    paymentsPoolID: 'XXX',
);

$response = $sdk->reconciliation->v1->createPolicy(
    request: $request
);

if ($response->policyResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request \formance\stack\Models\Reconciliation\PolicyRequest ✔️ The request object to use for the request.

Response

?Operations\CreatePolicyResponse

Errors

Error Type Status Code Content Type
\formance\stack\Models\Reconciliation\ErrorResponse default application/json
Errors\SDKException 4XX, 5XX */*

deletePolicy

Delete a policy by its id.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\DeletePolicyRequest(
    policyID: 'XXX',
);

$response = $sdk->reconciliation->v1->deletePolicy(
    request: $request
);

if ($response->statusCode === 200) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\DeletePolicyRequest ✔️ The request object to use for the request.

Response

?Operations\DeletePolicyResponse

Errors

Error Type Status Code Content Type
\formance\stack\Models\Reconciliation\ErrorResponse default application/json
Errors\SDKException 4XX, 5XX */*

getPolicy

Get a policy

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\GetPolicyRequest(
    policyID: 'XXX',
);

$response = $sdk->reconciliation->v1->getPolicy(
    request: $request
);

if ($response->policyResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\GetPolicyRequest ✔️ The request object to use for the request.

Response

?Operations\GetPolicyResponse

Errors

Error Type Status Code Content Type
\formance\stack\Models\Reconciliation\ErrorResponse default application/json
Errors\SDKException 4XX, 5XX */*

getReconciliation

Get a reconciliation

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\GetReconciliationRequest(
    reconciliationID: 'XXX',
);

$response = $sdk->reconciliation->v1->getReconciliation(
    request: $request
);

if ($response->reconciliationResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\GetReconciliationRequest ✔️ The request object to use for the request.

Response

?Operations\GetReconciliationResponse

Errors

Error Type Status Code Content Type
\formance\stack\Models\Reconciliation\ErrorResponse default application/json
Errors\SDKException 4XX, 5XX */*

getServerInfoReconciliation

Get server info

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();



$response = $sdk->reconciliation->v1->getServerInfoReconciliation(

);

if ($response->serverInfo !== null) {
    // handle response
}

Response

?Operations\GetServerInfoReconciliationResponse

Errors

Error Type Status Code Content Type
\formance\stack\Models\Reconciliation\ErrorResponse default application/json
Errors\SDKException 4XX, 5XX */*

listPolicies

List policies

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\ListPoliciesRequest(
    cursor: 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==',
    pageSize: 100,
);

$response = $sdk->reconciliation->v1->listPolicies(
    request: $request
);

if ($response->policiesCursorResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\ListPoliciesRequest ✔️ The request object to use for the request.

Response

?Operations\ListPoliciesResponse

Errors

Error Type Status Code Content Type
\formance\stack\Models\Reconciliation\ErrorResponse default application/json
Errors\SDKException 4XX, 5XX */*

listReconciliations

List reconciliations

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\ListReconciliationsRequest(
    cursor: 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==',
    pageSize: 100,
);

$response = $sdk->reconciliation->v1->listReconciliations(
    request: $request
);

if ($response->reconciliationsCursorResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\ListReconciliationsRequest ✔️ The request object to use for the request.

Response

?Operations\ListReconciliationsResponse

Errors

Error Type Status Code Content Type
\formance\stack\Models\Reconciliation\ErrorResponse default application/json
Errors\SDKException 4XX, 5XX */*

reconcile

Reconcile using a policy

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Reconciliation;
use formance\stack\Models\Shared;
use formance\stack\Utils;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\ReconcileRequest(
    reconciliationRequest: new \formance\stack\Models\Reconciliation\ReconciliationRequest(
        reconciledAtLedger: Utils\Utils::parseDateTime('2021-01-01T00:00:00.000Z'),
        reconciledAtPayments: Utils\Utils::parseDateTime('2021-01-01T00:00:00.000Z'),
    ),
    policyID: 'XXX',
);

$response = $sdk->reconciliation->v1->reconcile(
    request: $request
);

if ($response->reconciliationResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\ReconcileRequest ✔️ The request object to use for the request.

Response

?Operations\ReconcileResponse

Errors

Error Type Status Code Content Type
\formance\stack\Models\Reconciliation\ErrorResponse default application/json
Errors\SDKException 4XX, 5XX */*