Invoice API
      Back to home
      1. Help Center
      2. API
      3. Invoice API

      Payment API

      Create Cash Payment
      URL /ApiService.svc/Payment
      Method POST
      Body {
      "Amount": 5.00,
      "CreateDate": "/Date(1600204830747)/",
      "InvoiceId": 1,
      "PaymentType": "Cash",
      "UserPayeeId": 1
      }
      Response {
      "Amount": 5.00,
      "CheckNumber": null,
      "CreateDate": "/Date(1600204830747)/",
      "CustomId": "1082",
      "Id": 1041,
      "InvoiceId": 1,
      "PaymentStatus": "Settled",
      "PaymentType": "Cash",
      "UserPayeeId": 1
      }
      Comments

       
        Create Check Payment
      URL /ApiService.svc/Payment
      Method POST
      Body

      {
      "Amount": 5.00,
      "CheckNumber": 1,
      "CreateDate": "/Date(1600204830747)/",
      "InvoiceId": 1,
      "PaymentType": "Check",
      "UserPayeeId": 1
      }
      Response {
      "Amount": 5.00,
      "CheckNumber": "1",
      "CreateDate": "/Date(1600204830747)/",
      "CustomId": "1083",
      "Id": 1042,
      "InvoiceId": 1,
      "PaymentStatus": "Settled",
      "PaymentType": "Check",
      "UserPayeeId": 1
      }
      Comments

       
        Update Payment
      URL /ApiService.svc/Payment
      Method PUT
      Body

      {
      "Amount": 4.00,
      "CheckNumber": "1",
      "CreateDate": "/Date(1600204830747)/",
      "CustomId": "1083",
      "Id": 1042,
      "InvoiceId": 1,
      "PaymentType": "Check",
      "UserPayeeId": 1
      }
      Response {
      "Amount": 4.00,
      "CheckNumber": "1",
      "CreateDate": "/Date(1600204830747)/",
      "CustomId": "1083",
      "Id": 1042,
      "InvoiceId": 1,
      "PaymentStatus": "Settled",
      "PaymentType": "Check",
      "UserPayeeId": 1
      }
      Comments

       
        Delete Payment
      URL /ApiService.svc/Payment/{paymentId}
      Method DELETE
      Body

       
      Response

      HTTP 200 OK

      HTTP 400 {error message}
      Comments

      Credit card payments cannot be deleted.
        Get Payment List
      URL /ApiService.svc/Payment/List/{invoiceId}
      Method GET
      Body  
      Response
      [
          {
              "Amount": 100.00000,
              "CheckNumber": null,
              "CreateDate": "/Date(1600204830747+0000)/",
              "CustomId": "1-1",
              "Id": 1,
              "InvoiceId": 1,
              "PaymentStatus": "Settled",
              "PaymentType": "Cash",
              "UserPayeeId": null
          }
      ]
      Comments