README.md

FormanceReconciliationV1

(Reconciliation.V1)

Overview

Available Operations

• ReconciliationgetServerInfo - Get server info
• CreatePolicy - Create a policy
• ListPolicies - List policies
• DeletePolicy - Delete a policy
• GetPolicy - Get a policy
• Reconcile - Reconcile using a policy
• ListReconciliations - List reconciliations
• GetReconciliation - Get a reconciliation

ReconciliationgetServerInfo

Get server info

Example Usage

using formance;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Reconciliation.V1.ReconciliationgetServerInfoAsync();

// handle response

Response

ReconciliationgetServerInfoResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.ReconciliationErrorResponse	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	*/*

CreatePolicy

Create a policy

Example Usage

using formance;
using formance.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

PolicyRequest req = new PolicyRequest() {
    Name = "XXX",
    LedgerName = "default",
    LedgerQuery = new Dictionary<string, object>() {
        { "key", "<value>" },
    },
    PaymentsPoolID = "XXX",
};

var res = await sdk.Reconciliation.V1.CreatePolicyAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
request	PolicyRequest	✔️	The request object to use for the request.

Response

CreatePolicyResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.ReconciliationErrorResponse	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	*/*

ListPolicies

List policies

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Reconciliation.V1.ListPoliciesAsync(
    pageSize: 100,
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
PageSize	long	➖	The maximum number of results to return per page.	100
Cursor	string	➖	Parameter used in pagination requests. Maximum page size is set to 15. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.	aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==

Response

ListPoliciesResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.ReconciliationErrorResponse	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	*/*

DeletePolicy

Delete a policy by its id.

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Reconciliation.V1.DeletePolicyAsync(policyID: "XXX");

// handle response

Parameters

Parameter	Type	Required	Description	Example
PolicyID	string	✔️	The policy ID.	XXX

Response

DeletePolicyResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.ReconciliationErrorResponse	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	*/*

GetPolicy

Get a policy

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Reconciliation.V1.GetPolicyAsync(policyID: "XXX");

// handle response

Parameters

Parameter	Type	Required	Description	Example
PolicyID	string	✔️	The policy ID.	XXX

Response

GetPolicyResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.ReconciliationErrorResponse	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	*/*

Reconcile

Reconcile using a policy

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Reconciliation.V1.ReconcileAsync(
    policyID: "XXX",
    reconciliationRequest: new ReconciliationRequest() {
        ReconciledAtLedger = System.DateTime.Parse("2021-01-01T00:00:00.000Z"),
        ReconciledAtPayments = System.DateTime.Parse("2021-01-01T00:00:00.000Z"),
    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
PolicyID	string	✔️	The policy ID.	XXX
ReconciliationRequest	ReconciliationRequest	✔️	N/A

Response

ReconcileResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.ReconciliationErrorResponse	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	*/*

ListReconciliations

List reconciliations

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Reconciliation.V1.ListReconciliationsAsync(
    pageSize: 100,
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ=="
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
PageSize	long	➖	The maximum number of results to return per page.	100
Cursor	string	➖	Parameter used in pagination requests. Maximum page size is set to 15. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.	aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==

Response

ListReconciliationsResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.ReconciliationErrorResponse	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	*/*

GetReconciliation

Get a reconciliation

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Reconciliation.V1.GetReconciliationAsync(reconciliationID: "XXX");

// handle response

Parameters

Parameter	Type	Required	Description	Example
ReconciliationID	string	✔️	The reconciliation ID.	XXX

Response

GetReconciliationResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.ReconciliationErrorResponse	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	*/*