ProcuretAPI 0.0.2

A .NET Standard libary for the Procuret API. Procuret facilitates business to business transations. Suppliers get paid upfront, while customer businesses pay over time. Use Procuret .NET to add Procuret as a payment option in your .NET application.

There is a newer version of this package available.
See the version list below for details.
Install-Package ProcuretAPI -Version 0.0.2
dotnet add package ProcuretAPI --version 0.0.2
<PackageReference Include="ProcuretAPI" Version="0.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ProcuretAPI --version 0.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ProcuretAPI, 0.0.2"
For F# scripts that support #r syntax, copy this into the source code to reference the package.
// Install ProcuretAPI as a Cake Addin
#addin nuget:?package=ProcuretAPI&version=0.0.2

// Install ProcuretAPI as a Cake Tool
#tool nuget:?package=ProcuretAPI&version=0.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Procuret .NET

A Microsoft .NET Standard library for interfacing with the Procuret API.

Contents

  1. .NET API Compatibility
  2. Installation
  3. Documentation
  4. Support

.NET API Compatibility

Procuret .NET targets .NET Standard 1.6, which means it is compatible with
.NET Framework 4.7.2+ and .NET Core 1.0+. If you require comptatiblity with
an earlier .NET release, please contact us.

Installation

Procuret .NET is available as a
Nuget package.

dotnet add package ProcuretAPI

See Microsoft's documentation for more information about installing Nuget
packages in Visual Studios on Windows and
macOS.

If you require assistance installing Procuret .NET in your development
environment, please contact us.

Documentation

Procuret Python offers a library of classes that map to services provided
by the Procuret API.

Session

Sessions are the means of authenticating requests to the Procuret API. All
requests to Procuret API, save for those creating Sessions themselves, require
a Session.

In Procuret Python, the Session class will handle all authentication for you.
For example, it will compute the SHA256 signature that must be included
in your HTTP headers.

Initialiser
Parameters
  1. String apiKey
  2. ulong sessionId
Example Initialisation
Session session = Session(
    apiKey: "your_api_key",
    sessionId: 441121225 // Your Session ID
)

InstalmentLink

InstalmentLink facilitates the creation of customised links to the Procuret
Instalment Product (PIP). PIP allows a customer Business to pay for a purchase
over time, while you the Supplier are paid upfront.

When you create an InstalmentLink, you can ask Procuret to send an email
to the customer Business on your behalf.

Methods
static async Task<String>.create(...)
Parameters
  1. Int64 supplierId - Your unique Supplier ID
  2. String customerEmail - The email of the customer to whom a Procuret
    payment invitation email should be sent.
  3. String invoiceIdentifier - Your invoice identifier. E.g. "INV-001"
  4. Decimal invoiceValue - The amount payable by the customer
  5. CommunicationOption communication - Instance of CommunicationOption
    enumeration
  6. Session session - The Session to use when authenticating your request
Example Usage
await InstalmentLink.create(
    supplierId: 589121125121,
    customerEmail: "someone@somewhere.com",
    invoiceIdentifier: "INV-001",
    invoiceValue: Convert.ToDecimal("422.22"),
    communciation: CommunicationOption.NotifyCustomer,
    session: session // See Session create example above
)

At present, InstalmentLink does not return anything useful. The String
returned at task completion contains the raw JSON response from Procuret API.
You can expect a more useful return value in future versions of Procuret .NET.

CommunicationOption

An enumeration of instructions you can send Procuret in some contexts, to
tell it how you wish for it to contact (or not contact) the a customer.

Cases
  • .EMAIL_CUSTOMER - Procuret will contact the customer by email
  • .DO_NOT_CONTACT_CUSTOMER - Procuret will not try to contact the customer

Support

Please contact us anytime at support@procuret.com
with any questions. To chat with us less formally, please feel free to tweet
@hugh_jeremy.

For more general information about Procuret, please visit
procuret.com.

Procuret .NET

A Microsoft .NET Standard library for interfacing with the Procuret API.

Contents

  1. .NET API Compatibility
  2. Installation
  3. Documentation
  4. Support

.NET API Compatibility

Procuret .NET targets .NET Standard 1.6, which means it is compatible with
.NET Framework 4.7.2+ and .NET Core 1.0+. If you require comptatiblity with
an earlier .NET release, please contact us.

Installation

Procuret .NET is available as a
Nuget package.

dotnet add package ProcuretAPI

See Microsoft's documentation for more information about installing Nuget
packages in Visual Studios on Windows and
macOS.

If you require assistance installing Procuret .NET in your development
environment, please contact us.

Documentation

Procuret Python offers a library of classes that map to services provided
by the Procuret API.

Session

Sessions are the means of authenticating requests to the Procuret API. All
requests to Procuret API, save for those creating Sessions themselves, require
a Session.

In Procuret Python, the Session class will handle all authentication for you.
For example, it will compute the SHA256 signature that must be included
in your HTTP headers.

Initialiser
Parameters
  1. String apiKey
  2. ulong sessionId
Example Initialisation
Session session = Session(
    apiKey: "your_api_key",
    sessionId: 441121225 // Your Session ID
)

InstalmentLink

InstalmentLink facilitates the creation of customised links to the Procuret
Instalment Product (PIP). PIP allows a customer Business to pay for a purchase
over time, while you the Supplier are paid upfront.

When you create an InstalmentLink, you can ask Procuret to send an email
to the customer Business on your behalf.

Methods
static async Task<String>.create(...)
Parameters
  1. Int64 supplierId - Your unique Supplier ID
  2. String customerEmail - The email of the customer to whom a Procuret
    payment invitation email should be sent.
  3. String invoiceIdentifier - Your invoice identifier. E.g. "INV-001"
  4. Decimal invoiceValue - The amount payable by the customer
  5. CommunicationOption communication - Instance of CommunicationOption
    enumeration
  6. Session session - The Session to use when authenticating your request
Example Usage
await InstalmentLink.create(
    supplierId: 589121125121,
    customerEmail: "someone@somewhere.com",
    invoiceIdentifier: "INV-001",
    invoiceValue: Convert.ToDecimal("422.22"),
    communciation: CommunicationOption.NotifyCustomer,
    session: session // See Session create example above
)

At present, InstalmentLink does not return anything useful. The String
returned at task completion contains the raw JSON response from Procuret API.
You can expect a more useful return value in future versions of Procuret .NET.

CommunicationOption

An enumeration of instructions you can send Procuret in some contexts, to
tell it how you wish for it to contact (or not contact) the a customer.

Cases
  • .EMAIL_CUSTOMER - Procuret will contact the customer by email
  • .DO_NOT_CONTACT_CUSTOMER - Procuret will not try to contact the customer

Support

Please contact us anytime at support@procuret.com
with any questions. To chat with us less formally, please feel free to tweet
@hugh_jeremy.

For more general information about Procuret, please visit
procuret.com.

Release Notes

Add documentation of InstalmentLink

Dependencies

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
0.0.5 80 1/21/2021
0.0.4 77 12/11/2020
0.0.3 115 12/9/2020
0.0.2 141 9/24/2020
0.0.1 154 9/24/2020