Trade Enabler V3 - Invoice Presentment API

Enabling trade via a modern invoice presentation API

hello
  • Auth

    • Login

      no implementation for this version
      Login as an existing user in a customer with API Key. You need an API key in the header. Please contact us for details.
      Request:
      Resource:
      http://api.trade-enabler-site.com/public/api/{version}/user/login
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      Body:
      {
      "email": string, User email
      "password": string User password
      }
      Response:
      Body:
      {
      "access_token": string,
      "grace_period": integer,
      "refresh_token": string
      }
      Codes:
      Code Message Description
      200 Call Success. The token will be empty if there is a wrong password
      500 Call failed An exception has happened. This is not a wrong password indication
      Sample:
      Request:
      POST /public/api/v1/user/login HTTP/1.1 Content-Type: application/json; charset=utf-8 { "email": "my_email", "password": "my_password" }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "access_token": "my_access_token", "grace_period": 42, "refresh_token": "my_refresh_token" }
    • Password Change

      no implementation for this version
      Changes a users password.
      Request:
      Resource:
      http://api.trade-enabler-site.com/public/api/{version}/user/reset/
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      Body:
      {
      "newPassword": string, The new Password
      "oldPassword": string, The current Password
      "repeatPassword": string The new Password again
      }
      Response:
      Body:
      {
      "response_message": string
      }
      Codes:
      Code Message Description
      200 Call Success. Password reset successful. Please check your email.
      500 Call failed An exception has happened. This is not a wrong password indication
      Sample:
      Request:
      POST /public/api/v1/user/reset/ HTTP/1.1 Content-Type: application/json; charset=utf-8 { "newPassword": "my_newPassword", "oldPassword": "my_oldPassword", "repeatPassword": "my_repeatPassword" }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "response_message": "my_response_message" }
    • Password Reset

      no implementation for this version
      Resets a users password and sends link to the configured user email. Use this endpoint, if you forgot your existing password. The password reset needs to be approved by confirmeing in the email that you receive, so please monitor your inbox. If you received that request without having it initiated, simply ignore and delete the email.
      Request:
      Resource:
      http://api.trade-enabler-site.com/public/api/{version}/user/reset/
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      Body:
      {
      "email": string User email
      }
      Response:
      Body:
      {
      "response_message": string
      }
      Codes:
      Code Message Description
      200 Call Success. Password reset successful. Please check your email.
      500 Call failed An exception has happened. This is not a wrong password indication
      Sample:
      Request:
      POST /public/api/v1/user/reset/ HTTP/1.1 Content-Type: application/json; charset=utf-8 { "email": "my_email" }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "response_message": "my_response_message" }
  • Invoice

    • Get All Invoices

      no implementation for this version
      List all invoices for the logged-in user
      Request:
      Resource:
      http://api.trade-enabler-site.compublic/api/{version}/invoices
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      Response:
      Body:
      {
      "Invoices": [
      Invoice
      ]
      }
      Sample:
      Request:
      GET public/api/v1/invoices HTTP/1.1 Content-Type: application/json; charset=utf-8
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "Invoices": [ { "amount": 42, "ccy": "my_ccy", "company": "my_company", "customer_id": "my_customer_id", "date": "my_date", "due_date": "my_due_date", "file_attachment_id": "my_file_attachment_id", "invoice_number": "my_invoice_number", "payment_id": "my_payment_id", "receiver_company": "my_receiver_company", "receiver_customer_id": "my_receiver_customer_id", "receiver_email": "my_receiver_email", "receiver_wpy_id": "my_receiver_wpy_id", "ref": "my_ref", "status": "my_status", "wpy_id": "my_wpy_id" }, { "amount": 42, "ccy": "my_ccy", "company": "my_company", "customer_id": "my_customer_id", "date": "my_date", "due_date": "my_due_date", "file_attachment_id": "my_file_attachment_id", "invoice_number": "my_invoice_number", "payment_id": "my_payment_id", "receiver_company": "my_receiver_company", "receiver_customer_id": "my_receiver_customer_id", "receiver_email": "my_receiver_email", "receiver_wpy_id": "my_receiver_wpy_id", "ref": "my_ref", "status": "my_status", "wpy_id": "my_wpy_id" } ] }
    • Get All Presented Invoices (accounts receivable)

      no implementation for this version
      List all presented invoices for the logged-in user
      Request:
      Resource:
      http://api.trade-enabler-site.compublic/api/{version}/invoices/presented
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      Response:
      Body:
      {
      "Invoices": [
      Invoice
      ]
      }
      Sample:
      Request:
      GET public/api/v1/invoices/presented HTTP/1.1 Content-Type: application/json; charset=utf-8
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "Invoices": [ { "amount": 42, "ccy": "my_ccy", "company": "my_company", "customer_id": "my_customer_id", "date": "my_date", "due_date": "my_due_date", "file_attachment_id": "my_file_attachment_id", "invoice_number": "my_invoice_number", "payment_id": "my_payment_id", "receiver_company": "my_receiver_company", "receiver_customer_id": "my_receiver_customer_id", "receiver_email": "my_receiver_email", "receiver_wpy_id": "my_receiver_wpy_id", "ref": "my_ref", "status": "my_status", "wpy_id": "my_wpy_id" }, { "amount": 42, "ccy": "my_ccy", "company": "my_company", "customer_id": "my_customer_id", "date": "my_date", "due_date": "my_due_date", "file_attachment_id": "my_file_attachment_id", "invoice_number": "my_invoice_number", "payment_id": "my_payment_id", "receiver_company": "my_receiver_company", "receiver_customer_id": "my_receiver_customer_id", "receiver_email": "my_receiver_email", "receiver_wpy_id": "my_receiver_wpy_id", "ref": "my_ref", "status": "my_status", "wpy_id": "my_wpy_id" } ] }
    • Get All received Invoices (accounts payable)

      no implementation for this version
      List all received invoices for the logged-in user
      Request:
      Resource:
      http://api.trade-enabler-site.compublic/api/{version}/invoices/received
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      Response:
      Body:
      {
      "Invoices": [
      Invoice
      ]
      }
      Sample:
      Request:
      GET public/api/v1/invoices/received HTTP/1.1 Content-Type: application/json; charset=utf-8
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "Invoices": [ { "amount": 42, "ccy": "my_ccy", "company": "my_company", "customer_id": "my_customer_id", "date": "my_date", "due_date": "my_due_date", "file_attachment_id": "my_file_attachment_id", "invoice_number": "my_invoice_number", "payment_id": "my_payment_id", "receiver_company": "my_receiver_company", "receiver_customer_id": "my_receiver_customer_id", "receiver_email": "my_receiver_email", "receiver_wpy_id": "my_receiver_wpy_id", "ref": "my_ref", "status": "my_status", "wpy_id": "my_wpy_id" }, { "amount": 42, "ccy": "my_ccy", "company": "my_company", "customer_id": "my_customer_id", "date": "my_date", "due_date": "my_due_date", "file_attachment_id": "my_file_attachment_id", "invoice_number": "my_invoice_number", "payment_id": "my_payment_id", "receiver_company": "my_receiver_company", "receiver_customer_id": "my_receiver_customer_id", "receiver_email": "my_receiver_email", "receiver_wpy_id": "my_receiver_wpy_id", "ref": "my_ref", "status": "my_status", "wpy_id": "my_wpy_id" } ] }
    • Get an Invoice by ID

      no implementation for this version
      Get a single invoice by ID
      Request:
      Resource:
      http://api.trade-enabler-site.compublic/api/{version}/invoices/{invoice_id}
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      invoice_id string The Invoice Id
      Response:
      Body:
      {
      "Invoices": Invoice
      }
      Sample:
      Request:
      GET public/api/v1/invoices/my_invoice_id HTTP/1.1 Content-Type: application/json; charset=utf-8
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "Invoices": { "amount": 42, "ccy": "my_ccy", "company": "my_company", "customer_id": "my_customer_id", "date": "my_date", "due_date": "my_due_date", "file_attachment_id": "my_file_attachment_id", "invoice_number": "my_invoice_number", "payment_id": "my_payment_id", "receiver_company": "my_receiver_company", "receiver_customer_id": "my_receiver_customer_id", "receiver_email": "my_receiver_email", "receiver_wpy_id": "my_receiver_wpy_id", "ref": "my_ref", "status": "my_status", "wpy_id": "my_wpy_id" } }
    • Upload an Invoice

      no implementation for this version
      Upload an existing invoice file (pdf)
      Request:
      Resource:
      http://api.trade-enabler-site.compublic/api/{version}/invoices/file/{invoice_file_id}/
      URI Parameters:
      Parameter Type Optional Description
      version Version Api version
      invoice_file_id string Invoice identifier
      Body:
      {
      "file": string The file as multipart form/data
      }
      Response:
      Body:
      {
      "response_message": string
      }
      Codes:
      Code Message Description
      200 Invoice Created. The Invoice has been created and an email has been send to the receiver with the invoice link.
      500 Call failed An exception has happened. This is not a wrong password indication
      Sample:
      Request:
      POST public/api/v1/invoices/file/my_invoice_file_id/ HTTP/1.1 Content-Type: application/json; charset=utf-8 { "file": "my_file" }
      Response:
      HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "response_message": "my_response_message" }
    • Invoice

      no implementation for this version
      An invoice
      Presentation:
      {
      "amount": integer, Invoice amount
      "ccy": string, the curreny code e.g EUR or USD
      "company": string, Needs Description - The company
      "customer_id": string, Needs Description - The customer
      "date": string, Invoice date
      "due_date": string, Invoice due date
      "file_attachment_id": string, File attachemnet id
      "invoice_number": string, The invoice number
      "payment_id": string, Needs Description -The payment ID
      "receiver_company": string, The company name of the payee
      "receiver_customer_id": string, Needs Description - The customer id in TSG Core ?
      "receiver_email": string, The email of the payee
      "receiver_wpy_id": string, Needs Description - The WPAY ID of the payee
      "ref": string, Invoice reference
      "status": string, Email address of the user
      "wpy_id": string Needs Description - The WPAY ID of ...
      }
      Formats:
      Sample:
      { "amount": 42, "ccy": "my_ccy", "company": "my_company", "customer_id": "my_customer_id", "date": "my_date", "due_date": "my_due_date", "file_attachment_id": "my_file_attachment_id", "invoice_number": "my_invoice_number", "payment_id": "my_payment_id", "receiver_company": "my_receiver_company", "receiver_customer_id": "my_receiver_customer_id", "receiver_email": "my_receiver_email", "receiver_wpy_id": "my_receiver_wpy_id", "ref": "my_ref", "status": "my_status", "wpy_id": "my_wpy_id" }
    • Version

      no implementation for this version
      A version
      Presentation:
      string
      Formats:
      Pretty Print:
      VN
      Advanced:
      V\d+
      Sample:
      "v1"