Account Functions/Invoice Functions

Operations related to Qvalia accounts functions

Get status

post

/account/{accountRegNo}/action/invoice/outgoing/status/{integrationId}

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

Authorizations

AuthorizationstringRequired

Path parameters

accountRegNostringRequired

Account registration number issued by Qvalia

integrationIdstringRequired

The integration id (UUID v4) of the transaction/message to get status for

Example: a1b2c3d4-5678-90ab-cdef-1234567890ab

Body

objectOptional

Responses

200Success

application/json

statusstringOptional

post/account/{accountRegNo}/action/invoice/outgoing/status/{integrationId}

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

/account/{accountRegNo}/action/invoice/createandsend/{integrationId}

(Requires “Order to Cash” (O2C) or Order Management addon)\n\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

AuthorizationstringRequired

Path parameters

accountRegNostringRequired

Account registration number issued by Qvalia

integrationIdstringRequired

The integration id (UUID v4) of the transaction/message to get status for

Example: a1b2c3d4-5678-90ab-cdef-1234567890ab

Body

Responses

200Success

application/json

statusstringOptionalExample: success

post/account/{accountRegNo}/action/invoice/createandsend/{integrationId}

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"
      }
    }
  }
}