API Documentation

Introduction

This document provides an overview of the available API endpoints for integrating with NoTalkPayments application.
The base URL for the NoTalkPayments API is: TBD
All requests to the API must be made over HTTPS. Requests over HTTP will fail.
All requests and responses are formatted in JSON.

Authentication

NoTalkPayments endpoints require authentication for all requests. You can authenticate by including the API key in the request header.

Example

Authorization: Bearer YOUR_API_KEY
Be careful to never expose your API credentials in any client-side code.

API Key Generation

To create and access your API key, you need to follow the steps below. Note that only Company Admins can create API keys on NoTalkPayments.

  • Navigate to Admin Settings > My Company > Authentication > API Keys
  • Select Add Key
  • Name your key and set the expiration terms
  • Select Save

Response Codes

The NoTalkPayments API will communicate responses using standard HTTP codes.

HTTP Code Description
200 OK (Everything worked as expected.)
400 Bad Request (This often means a required parameter is missing.)
401 Unauthorized
404 Not Found (The requested item does not exist.)
429 Too Many Requests
500 Internal server error

Rate Limits

We have rate limits in place in order to provide a fair response time to all our API users.

The primary rate limit is 40 requests per second. All requests count towards the rate limit.

If the rate limit is exceeded, the API returns a 429 status code indicating Too Many Requests, with the error message Your request rate has exceeded our rate limit.


Business Unit GET

Description: Retrieves a Business Unit from your account
URL: /api/BusinessUnit/{id}
Method GET
Content-Type application/json
Response body
  { 
      "businessUnitExternalId": string, 
      "customerId": number, 
      "name": string, 
      "address": string, 
      "city": string, 
      "provinceCode": string, 
      "countryCode": string 
  }

Business Unit POST

Description: Creates a Business Unit object under your account
URL: /api/BusinessUnit
Method POST
Content-Type application/json
Request body
  { 
    "businessUnitExternalId": string,
    "customerId": number, 
    "name": string, 
    "address": string, 
    "city": string, 
    "provinceCode": string, 
    "countryCode": string 
  } 
Response body
  { 
    "id": number, 
    "businessUnitExternalId": string, 
    "customerId": number, 
    "name": string, 
    "address": string, 
    "city": string, 
    "provinceCode": string, 
    "countryCode": string 
  }  

Business Unit PUT

Description: Creates a Business Unit object under your account
URL: /api/BusinessUnit
Method PUT
Content-Type application/json
Request body
  { 
    "id": number, 
    "businessUnitExternalId": string,
    "customerId": number, 
    "name": string, 
    "address": string, 
    "city": string, 
    "provinceCode": string, 
    "countryCode": string 
  } 
Response body
  { 
    "id": number, 
    "businessUnitExternalId": string, 
    "customerId": number, 
    "name": string, 
    "address": string, 
    "city": string, 
    "provinceCode": string, 
    "countryCode": string 
  }  

Business Unit DELETE

Description: Delete a Business Unit object under your account
URL: /api/BusinessUnit/{id}
Method DELETE
Content-Type application/json

DebtorGET

Description: Retrieves a Debtor from your account
URL: /api/Debtor/{id}
Method GET
Content-Type application/json
Response body
  { 
    "id": number, 
    "debtorExternalId": string,
    "customerId": number, 
    "firstName": string, 
    "lastName": string, 
    "email": string, 
    "workPhone": string, 
    "homePhone": string, 
    "address": string, 
    "city": string, 
    "provinceCode": string, 
    "countryCode": string, 
    "dateOfBirth": date, 
    "employeerName":string 
  } 

Debtor POST

Description: Creates a Debtor object under your account
URL: /api/Debtor
Method POST
Content-Type application/json
Request body
  { 
    "debtorExternalId": string,
    "customerId": number, 
    "firstName": string, 
    "lastName": string, 
    "email": string, 
    "workPhone": string, 
    "homePhone": string, 
    "address": string, 
    "city": string, 
    "provinceCode": string, 
    "countryCode": string, 
    "dateOfBirth": date, 
    "employeerName":string 
  }  
Response body
  {
    "id": number, 
    "debtorExternalId": string, 
    "customerId": number, 
    "firstName": string, 
    "lastName": string, 
    "email": string, 
    "workPhone": string, 
    "homePhone": string, 
    "address": string, 
    "city": string, 
    "provinceCode": string, 
    "countryCode": string, 
    "dateOfBirth": date, 
    "employeerName":string 
  }   

Debtor PUT

Description: Update a Debtor object under your account
URL: /api/Debtor
Method PUT
Content-Type application/json
Request body
  { 
    "id": number, 
    "debtorExternalId": string,
    "customerId": number, 
    "firstName": string, 
    "lastName": string, 
    "email": string, 
    "workPhone": string, 
    "homePhone": string, 
    "address": string, 
    "city": string, 
    "provinceCode": string, 
    "countryCode": string, 
    "dateOfBirth": date, 
    "employeerName":string 
  }  
Response body
  {
    "id": number, 
    "debtorExternalId": string, 
    "customerId": number, 
    "firstName": string, 
    "lastName": string, 
    "email": string, 
    "workPhone": string, 
    "homePhone": string, 
    "address": string, 
    "city": string, 
    "provinceCode": string, 
    "countryCode": string, 
    "dateOfBirth": date, 
    "employeerName":string 
  }   

Debtor DELETE

Description: Delete a Debtor object under your account
URL: /api/Debtor/{id}
Method DELETE
Content-Type application/json

Invoice GET

Description: Retrieves a Invoice from your account
URL: /api/Invoice/{id}
Method GET
Content-Type application/json
Response body
  {
    "id": number,
    "debtorId": number, 
    "invoiceExternalNumber": string, 
    "description": string, 
    "currencyCode": string, 
    "references": [{
      "firstName": string, 
      "lastName": string, 
      "homePhone": string,
      "workPhone": string,
      "OtherPhone": string,
      "Occuppation": string,
      "Email": string 
    }], 
    "amount": number, 
    "dueDate": DateOnly, 
    "invoiceDate": DateOnly, 
    "businessUnitExternalId": string 
  }                   
  

Invoice POST

Description: Creates a Invoice object under your account
URL: /api/Invoice
Method POST
Content-Type application/json
Request body
  { 
    "invoiceExternalNumber": string, 
    "description": string, 
    "currencyCode": string, 
    "references": [{ 
      "firstName": string, 
      "lastName": string,
      "homePhone": string,
      "workPhone": string,
      "OtherPhone": string,
      "Occuppation": string,
      "Email": string
    }], 
    "amount": 0, 
    "dueDate": DateOnly, 
    "invoiceDate": DateOnly, 
    "businessUnitExternalId": string 
  }                   
    
Response body
  {
  "id": number,
  "debtorId": number, 
  "invoiceExternalNumber": string, 
  "description": string, 
  "currencyCode": string, 
  "references": [{ 
    "firstName": string,
    "lastName": string,
    "homePhone": string,
    "workPhone": string,
    "OtherPhone": string,
    "Occuppation": string,
    "Email": string
  }], 
  "amount": 0, 
  "dueDate": DateOnly, 
  "invoiceDate": DateOnly, 
  "businessUnitExternalId": string 
  }                   
      

Invoice PUT

Description: Creates a Invoice object under your account
URL: /api/Invoice
Method PUT
Content-Type application/json
Request body
  { 
    "id": number,
    "invoiceExternalNumber": string, 
    "description": string, 
    "currencyCode": string, 
    "references": [{ 
      "firstName": string, 
      "lastName": string,
      "homePhone": string,
      "workPhone": string,
      "OtherPhone": string,
      "Occuppation": string,
      "Email": string
    }], 
    "amount": 0, 
    "dueDate": DateOnly, 
    "invoiceDate": DateOnly, 
    "businessUnitExternalId": string 
  }                   
    
Response body
  {
  "id": number,
  "debtorId": number, 
  "invoiceExternalNumber": string, 
  "description": string, 
  "currencyCode": string, 
  "references": [{ 
    "firstName": string,
    "lastName": string,
    "homePhone": string,
    "workPhone": string,
    "OtherPhone": string,
    "Occuppation": string,
    "Email": string
  }], 
  "amount": 0, 
  "dueDate": DateOnly, 
  "invoiceDate": DateOnly, 
  "businessUnitExternalId": string 
  }                   
      

Invoice DELETE

Description: Delete a Invoice object under your account
URL: /api/Invoice/{id}
Method DELETE
Content-Type application/json

Revolutionary AI Driven Collection Software.

Reach | Incentivize | Collect & Recover

TOP