API - Payments

Payments

[GET] /payment/<payment_id>
Example request:

GET  /qbench/api/v1/payment/27 HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>

Example response:

{
  'amount': 721.0,
  'created_by_api_client_id': '060f4a7d-237d-448c-812f-101199d0c757',
  'created_by_user_id': None,
  'customer_id': 2,
  'date_created': '06/24/2020',
  'external_id': None,
  'id': 27,
  'invoice_payments': [],
  'last_updated': '1593028033',
  'payment_date': '06/24/2020',
  'payment_type': 'Credit Card',
  'qb4f8': '7cd98c8',
  'unapplied_amount': 721.0
}

[POST] /payment

Example request:

POST  /qbench/api/v1/payment HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>
Content-Type: application/json
{
  "customer_id": 2,
  "payment_date": '01/01/2020',
  "payment_type_id": 4,
  "amount": 200
}

Example response:

{"id": 73}

[GET] /payment
Example request:

GET  /qbench/api/v1/payment HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>

Example Response:

{
  'data':
    [
      {
        'amount': 10.0,
        'created_by_api_client_id': '060f4a7d-237d-448c-812f-101199d0c757',
        'created_by_user_id': None,
        'customer_id': 2,
        'date_created': '06/24/2020',
        'external_id': None,
        'id': 59,
        'invoice_payments':
          [
            {
              'applied_amount': 5.0,
              'date_created': '06/24/2020 10:26 PM',
              'id': 62,
              'invoice_id': 9
            },
            {
              'applied_amount': 5.0,
              'date_created': '06/24/2020 10:26 PM',
              'id': 61,
              'invoice_id': 7
            }
          ],
        'last_updated': '1593037565',
        'payment_date': '06/24/2020',
        'payment_type': 'Credit Card',
        'unapplied_amount': 0.0
      },
      {
        'amount': 6.65,
        'created_by_api_client_id': None,
        'created_by_user_id': 40,
        'customer_id': 2,
        'date_created': '06/24/2020',
        'external_id': None,
        'id': 58,
        'invoice_payments':
          [
            {
              'applied_amount': 6.65,
              'date_created': '06/24/2020 10:09 PM',
              'id': 60,
              'invoice_id': 556}],
              'last_updated': '1593036556',
              'payment_date': '06/24/2020',
              'payment_type': None,
              'unapplied_amount': 0.0
      },
      {
        'amount': 9.0,
        'created_by_api_client_id': None,
        'created_by_user_id': 40,
        'customer_id': 2,
        'date_created': '06/24/2020',
        'external_id': None,
        'id': 57,
        'invoice_payments': [],
        'last_updated': '1593036547',
        'payment_date': '06/24/2020',
        'payment_type': None,
        'unapplied_amount': 9.0
      },
      {
        'amount': 516.29,
        'created_by_api_client_id': None,
        'created_by_user_id': 40,
        'customer_id': 2,
        'date_created': '06/24/2020',
        'external_id': None,
        'id': 56,
        'invoice_payments':
          [
            {
              'applied_amount': 516.29,
              'date_created': '06/24/2020 09:47 PM',
              'id': 58,
              'invoice_id': 556
            }
          ],
        'last_updated': '1593035250',
        'payment_date': '06/24/2020',
        'payment_type': None,
        'unapplied_amount': 0.0
      },
      {
        'amount': 0.02,
        'created_by_api_client_id': None,
        'created_by_user_id': 40,
        'customer_id': 2,
        'date_created': '06/24/2020',
        'external_id': None,
        'id': 55,
        'invoice_payments':
          [
            {
              'applied_amount': 0.02,
              'date_created': '06/24/2020 09:46 PM',
              'id': 57,
              'invoice_id': 556
            }
          ],
        'last_updated': '1593035199',
        'payment_date': '06/24/2020',
        'payment_type': None,
        'unapplied_amount': 0.0
      }
    ],
  'qb5': 'a2398',
  'total_count': 47,
  'total_pages': 10
}

[DELETE] /payment/<payment_id>

Example request:

DELETE /qbench/api/v1/payment HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>

Example response:

{"message": "OK"}

[PUT] /payment/<payment_id>

Example request:

PUT /qbench/api/v1/payment/74 HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>
Content-Type: application/json
{
  "customer_id": 2,
  "payment_date": '01/01/2020',
  "payment_type_id": 4,
  "amount": 200
}

Example response:

{"message": "OK"}

[POST] /payment/<payment_id>/apply

Applies a Payment to multiple Invoices.

Expects a dictionary with the format:

{
  "invoice_payments": [
      {"invoice_id": 123, "applied_amount": 50},
      {"invoice_id": 223, "applied_amount": 40},
      {"invoice_id": 323, "applied_amount": 30}
    ]
}

Response:

{"message": "OK"}

[POST] /payment/<payment_id>/invoice/<invoice_id>

Applies a Payment to a single Invoice.

Expects a dictionary with the format:

{
 "applied_amount": 50
 }

Response:

{"message": "OK"}

[DELETE] /payment/<payment_id>/invoice/<invoice_id>
Does not need a JSON body, just a valid payment_id and invoice_id pair to delete

Response:

{"message": "OK"}