LogoLogo
  • Qvalia Developer Tools
    • API
    • JSON/XML or JSON to XML
    • Attachments to messages
  • Quick Start
  • API Documentation
    • API's
      • Transaction API
        • Invoice APIs
        • CreditNote APIs
        • Order APIs
        • OrderResponse APIs
        • OrderChange APIs
        • OrderCancellation APIs
        • Catalogue APIs
        • DespatchAdvice APIs
      • Enrichment API
        • Enrichment API
      • Partner API
        • Partner API
      • Account API
        • Account Functions/Invoice Functions
  • Sample Data
    • API Sample Data
      • Invoice
      • CreditNote
      • Order
      • OrderResponse
      • OrderChange
      • OrderCancellation
      • Catalogue
      • DespatchAdvice
  • SFTP Integration
    • SFTP Integration
  • VAN Operator
    • Operators
  • Qvalia
    • Home
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. API Documentation
  2. API's
  3. Account API

Account Functions/Invoice Functions

PreviousAccount APINextAPI Sample Data

Was this helpful?

  • POSTGet status
  • POSTCreate from Order

Get status

post

Invoice related endpoints.\nNB! All Invoice data under the /account endpoints require JSON and only UBL JSON data are supported.

Authorizations
Path parameters
accountRegNostringRequiredDefault: ""
integrationIdstringRequiredDefault: ""
Body
objectOptional
Responses
200Success
application/json
post
POST /account/{accountRegNo}/action/invoice/outgoing/status/{integrationId} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200Success
{
  "status": "text",
  "data": {
    "message": "text",
    "status": {
      "document_id": "text",
      "order_number": "text",
      "payment_reference": "text",
      "credit_note": "text",
      "reminder": "text",
      "status": "text",
      "sent_at": "text",
      "paid_at": "text",
      "cancelled_at": "text",
      "send_method": "text"
    }
  }
}

Create from Order

post

(Requires “Order to Cash” (O2C) or Order Management addon)\n/account/{accountRegNo}/action/invoice/createandsend/{integrationId}\n\nThis Endpoint will use an Incoming Order and generate an Outgoing Invoice from it.\n\nNB! The Addressing (EndpointID) in the Order will be used as Address for the Outgoing Invoice!\n\nYou need to “update” the Order by using the overwrite flag on it to change the Addressing, if needed!

Authorizations
Path parameters
accountRegNostringRequiredDefault: ""
integrationIdstringRequiredDefault: ""
Body
Responses
200Success
application/json
post
POST /account/{accountRegNo}/action/invoice/createandsend/{integrationId} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "send": {
    "method": "text"
  }
}
200Success
{
  "status": "success",
  "data": {
    "message": "invoice successfully created and sent as email",
    "data": {
      "invoice": {
        "Invoice": "UBL JSON Invoice data"
      }
    }
  }
}