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

Retrieves a Business Unit from your account

RESPONSE BODY SCHEMA
businessUnitExternalId string
customerId number
name string
address string
city string
provinceCode string 2 characters
countryCode string 2 characters

GET /api/BusinessUnit/{id}

Response samples

  { 
      businessUnitExternalId: "BUID-001", 
      customerId: 1, 
      name: "MY BUSSINESS UNIT", 
      address: "4100 QUEBEC ST", 
      city: "VANCOUVER", 
      provinceCode: "BC", 
      countryCode: "CA" 
  }


Business Unit POST

Creates a Business Unit object under your account

REQUEST BODY SCHEMA
businessUnitExternalId string
customerId number
name string
address string
city string
provinceCode string 2 characters
countryCode string 2 characters

RESPONSE BODY SCHEMA
id number
businessUnitExternalId string
customerId number
name string
address string
city string
provinceCode string 2 characters
countryCode string 2 characters

POST /api/BusinessUnit

Request samples

  {   
      businessUnitExternalId: "BUID-001", 
      customerId: 1, 
      name: "MY BUSSINESS UNIT", 
      address: "4100 QUEBEC ST", 
      city: "VANCOUVER", 
      provinceCode: "BC", 
      countryCode: "CA" 
  }

Response samples

  { 
      id: 123,
      businessUnitExternalId: "BUID-001", 
      customerId: 1, 
      name: "MY BUSSINESS UNIT", 
      address: "4100 QUEBEC ST", 
      city: "VANCOUVER", 
      provinceCode: "BC", 
      countryCode: "CA" 
  }


Business Unit PUT

Update a Business Unit object under your account

REQUEST BODY SCHEMA
businessUnitExternalId string
customerId number
name string
address string
city string
provinceCode string 2 characters
countryCode string 2 characters

RESPONSE BODY SCHEMA
id number
businessUnitExternalId string
customerId number
name string
address string
city string
provinceCode string 2 characters
countryCode string 2 characters

POST /api/BusinessUnit

Request samples

  {   
      businessUnitExternalId: "BUID-001", 
      customerId: 1, 
      name: "MY BUSSINESS UNIT", 
      address: "4100 QUEBEC ST", 
      city: "VANCOUVER", 
      provinceCode: "BC", 
      countryCode: "CA" 
  }

Response samples

  { 
      id: 123,
      businessUnitExternalId: "BUID-001", 
      customerId: 1, 
      name: "MY BUSSINESS UNIT", 
      address: "4100 QUEBEC ST", 
      city: "VANCOUVER", 
      provinceCode: "BC", 
      countryCode: "CA" 
  }


Business Unit DELETE

Delete a Business Unit object under your account

PATH PARAMETERS
id number required

DELETE /api/BusinessUnit/{id}

Response samples



DebtorGET

Retrieves a Debtor from your account

RESPONSE BODY SCHEMA
id number
debtorExternalId string
customerId number
firstName string
lastName string
email string
workPhone string
homePhone string
address string
city string
provinceCode string 2 characters
countryCode string 2 characters
dateOfBirth date
employeerName string

GET /api/Debtor/{id}

Response samples

      {
        id: 1,
        debtorExternalId: "d-12345",
        customerId: 123,
        firstName: "John",
        lastName: "Doe",
        email: "john.doe@example.com",
        workPhone: "555-555-5555",
        homePhone: "555-555-5556",
        address: "123 Main St",
        city: "Vancouver",
        provinceCode: "BC",
        countryCode: "CA",
        dateOfBirth: "1980-01-01",
        employeerName: "ACME Inc"
      }


Debtor POST

Creates a Debtor object under your account

REQUEST BODY SCHEMA
debtorExternalId string
customerId number
firstName string
lastName string
email string
workPhone string
homePhone string
address string
city string
provinceCode string 2 characters
countryCode string 2 characters
dateOfBirth date
employeerName string

RESPONSE BODY SCHEMA
id number
debtorExternalId string
customerId number
firstName string
lastName string
email string
workPhone string
homePhone string
address string
city string
provinceCode string 2 characters
countryCode string 2 characters
dateOfBirth date
employeerName string

POST /api/Debtor/{id}

Request samples

      {
        debtorExternalId: "d-12345",
        customerId: 123,
        firstName: "John",
        lastName: "Doe",
        email: "john.doe@example.com",
        workPhone: "555-555-5555",
        homePhone: "555-555-5556",
        address: "123 Main St",
        city: "Vancouver",
        provinceCode: "BC",
        countryCode: "CA",
        dateOfBirth: "1980-01-01",
        employeerName: "ACME Inc"
      }

Response samples

      {
        id: 1,
        debtorExternalId: "d-12345",
        customerId: 123,
        firstName: "John",
        lastName: "Doe",
        email: "john.doe@example.com",
        workPhone: "555-555-5555",
        homePhone: "555-555-5556",
        address: "123 Main St",
        city: "Vancouver",
        provinceCode: "BC",
        countryCode: "CA",
        dateOfBirth: "1980-01-01",
        employeerName: "ACME Inc"
      }


Debtor PUT

Update a Debtor object under your account

REQUEST BODY SCHEMA
id number
debtorExternalId string
customerId number
firstName string
lastName string
email string
workPhone string
homePhone string
address string
city string
provinceCode string 2 characters
countryCode string 2 characters
dateOfBirth date
employeerName string

RESPONSE BODY SCHEMA
id number
debtorExternalId string
customerId number
firstName string
lastName string
email string
workPhone string
homePhone string
address string
city string
provinceCode string 2 characters
countryCode string 2 characters
dateOfBirth date
employeerName string

PUT /api/Debtor/{id}

Request samples

      {
        debtorExternalId: "d-12345",
        customerId: 123,
        firstName: "John",
        lastName: "Doe",
        email: "john.doe@example.com",
        workPhone: "555-555-5555",
        homePhone: "555-555-5556",
        address: "123 Main St",
        city: "Vancouver",
        provinceCode: "BC",
        countryCode: "CA",
        dateOfBirth: "1980-01-01",
        employeerName: "ACME Inc"
      }

Response samples

      {
        id: 1,
        debtorExternalId: "d-12345",
        customerId: 123,
        firstName: "John",
        lastName: "Doe",
        email: "john.doe@example.com",
        workPhone: "555-555-5555",
        homePhone: "555-555-5556",
        address: "123 Main St",
        city: "Vancouver",
        provinceCode: "BC",
        countryCode: "CA",
        dateOfBirth: "1980-01-01",
        employeerName: "ACME Inc"
      }


Debtor DELETE

Delete a Debtor object under your account

PATH PARAMETERS
id number required

DELETE /api/Debtor/{id}

Response samples



Invoice GET

Retrieves a Invoice from your account

RESPONSE BODY SCHEMA
id number
debtorId number
invoiceExternalNumber string
firstName string
lastName string
homePhone string
workPhone string
OtherPhone string
Occuppation string
Email string
amount string
dueDate DateOnly
invoiceDate DateOnly
businessUnitExternalId string

GET /api/Debtor/{id}

Response samples

      {
        id: 1,
        debtorId: 1234,
        invoiceExternalNumber: "INV-001",
        description: "Sample Invoice Description",
        currencyCode: "CAD",
        references: [
          {
            firstName: "John",
            lastName: "Doe",
            homePhone: "555-555-5555",
            workPhone: "555-555-5556",
            otherPhone: "555-555-5557",
            occuppation: "Software Engineer",
            email: "john.doe@example.com"
          },
          {
            firstName: "Jane",
            lastName: "Doe",
            homePhone: "555-555-5558",
            workPhone: "555-555-5559",
            otherPhone: "555-555-5560",
            occuppation: "Data Analyst",
            email: "jane.doe@example.com"
          }
        ],
        amount: 1234.56,
        dueDate: "2023-02-28",
        invoiceDate: "2023-01-01",
        businessUnitExternalId: "BU-001"
      }


Invoice POST

Creates a Invoice object under your account

REQUEST BODY SCHEMA
debtorId number
invoiceExternalNumber string
firstName string
lastName string
homePhone string
workPhone string
OtherPhone string
Occuppation string
Email string
amount string
dueDate DateOnly
invoiceDate DateOnly
businessUnitExternalId string

RESPONSE BODY SCHEMA
id number
debtorId number
invoiceExternalNumber string
firstName string
lastName string
homePhone string
workPhone string
OtherPhone string
Occuppation string
Email string
amount string
dueDate DateOnly
invoiceDate DateOnly
businessUnitExternalId string

POST /api/Invoice/{id}

Request samples

      {                   
        debtorId: 1234,
        invoiceExternalNumber: "INV-001",
        description: "Sample Invoice Description",
        currencyCode: "CAD",
        references: [
          {
            firstName: "John",
            lastName: "Doe",
            homePhone: "555-555-5555",
            workPhone: "555-555-5556",
            otherPhone: "555-555-5557",
            occuppation: "Software Engineer",
            email: "john.doe@example.com"
          },
          {
            firstName: "Jane",
            lastName: "Doe",
            homePhone: "555-555-5558",
            workPhone: "555-555-5559",
            otherPhone: "555-555-5560",
            occuppation: "Data Analyst",
            email: "jane.doe@example.com"
          }
        ],
        amount: 1234.56,
        dueDate: "2023-02-28",
        invoiceDate: "2023-01-01",
        businessUnitExternalId: "BU-001"
      }

Response samples

      {
        id: 1,
        debtorId: 1234,
        invoiceExternalNumber: "INV-001",
        description: "Sample Invoice Description",
        currencyCode: "CAD",
        references: [
          {
            firstName: "John",
            lastName: "Doe",
            homePhone: "555-555-5555",
            workPhone: "555-555-5556",
            otherPhone: "555-555-5557",
            occuppation: "Software Engineer",
            email: "john.doe@example.com"
          },
          {
            firstName: "Jane",
            lastName: "Doe",
            homePhone: "555-555-5558",
            workPhone: "555-555-5559",
            otherPhone: "555-555-5560",
            occuppation: "Data Analyst",
            email: "jane.doe@example.com"
          }
        ],
        amount: 1234.56,
        dueDate: "2023-02-28",
        invoiceDate: "2023-01-01",
        businessUnitExternalId: "BU-001"
      }


Invoice PUT

Update a Invoice object under your account

REQUEST BODY SCHEMA
id number
debtorId number
invoiceExternalNumber string
firstName string
lastName string
homePhone string
workPhone string
otherPhone string
occuppation string
email string
amount string
dueDate DateOnly
invoiceDate DateOnly
businessUnitExternalId string

RESPONSE BODY SCHEMA
id number
debtorId number
invoiceExternalNumber string
firstName string
lastName string
homePhone string
workPhone string
otherPhone string
occuppation string
email string
amount string
dueDate DateOnly
invoiceDate DateOnly
businessUnitExternalId string

PUT /api/Invoice/{id}

Request samples

      { 
        id: 1                  
        debtorId: 1234,
        invoiceExternalNumber: "INV-001",
        description: "Sample Invoice Description",
        currencyCode: "CAD",
        references: [
          {
            firstName: "John",
            lastName: "Doe",
            homePhone: "555-555-5555",
            workPhone: "555-555-5556",
            otherPhone: "555-555-5557",
            occuppation: "Software Engineer",
            email: "john.doe@example.com"
          },
          {
            firstName: "Jane",
            lastName: "Doe",
            homePhone: "555-555-5558",
            workPhone: "555-555-5559",
            otherPhone: "555-555-5560",
            occuppation: "Data Analyst",
            email: "jane.doe@example.com"
          }
        ],
        amount: 1234.56,
        dueDate: "2023-02-28",
        invoiceDate: "2023-01-01",
        businessUnitExternalId: "BU-001"
      }

Response samples

      {
        id: 1,
        debtorId: 1234,
        invoiceExternalNumber: "INV-001",
        description: "Sample Invoice Description",
        currencyCode: "CAD",
        references: [
          {
            firstName: "John",
            lastName: "Doe",
            homePhone: "555-555-5555",
            workPhone: "555-555-5556",
            otherPhone: "555-555-5557",
            occuppation: "Software Engineer",
            email: "john.doe@example.com"
          },
          {
            firstName: "Jane",
            lastName: "Doe",
            homePhone: "555-555-5558",
            workPhone: "555-555-5559",
            otherPhone: "555-555-5560",
            occuppation: "Data Analyst",
            email: "jane.doe@example.com"
          }
        ],
        amount: 1234.56,
        dueDate: "2023-02-28",
        invoiceDate: "2023-01-01",
        businessUnitExternalId: "BU-001"
      }


Invoice DELETE

Delete a Invoice object under your account

PATH PARAMETERS
id number required

DELETE /api/Invoice/{id}

Response samples



Revolutionary AI Driven Collection Software.

Reach | Incentivize | Collect & Recover

Get Started Today!
TOP