LogoLogo
  • Qvalia Developer Tools
    • API
    • JSON/XML or JSON to XML
    • Attachments to messages
  • Quick Start
  • API Documentation
    • API's
      • Invoice APIs
      • Credit Note APIs
      • Order APIs
      • Order Response APIs
      • Order Change APIs
      • Order Cancellation APIs
      • Catalogue APIs
      • Despatch Advice
      • Enrichment API
      • Partner
  • 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

Credit Note APIs

PreviousInvoice APIsNextOrder APIs

Was this helpful?

Get incoming read credit notes

get

APIs related to credit note handing

Path parameters
accountRegNoStringOptionalDefault: ""
Query parameters
limitStringOptionalDefault: ""
includeReadStringOptionalDefault: ""
offsetStringOptionalDefault: ""
documentIdStringOptionalDefault: ""
fromStringOptionalDefault: ""
toStringOptionalDefault: ""
updatedAtFromStringOptionalDefault: ""
updatedAtToStringOptionalDefault: ""
Header parameters
AuthorizationstringOptionalDefault: ""
AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""
Responses
200Success
application/json
204
No content
application/json
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
500Error
application/json
get
GET /transaction/{accountRegNo}/creditNotes/incoming/readCreditNotes HTTP/1.1
Host: api.qvalia.com
Accept: */*

{
  "status": "success",
  "data": [
    {}
  ]
}

Get outgoing credit notes

get

APIs related to credit note handing

Path parameters
accountRegNoStringOptionalDefault: ""
Header parameters
AuthorizationstringOptionalDefault: ""
AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""
Responses
200Success
application/json
204
No content
application/json
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
500Error
application/json
get
GET /transaction/{accountRegNo}/creditNotes/outgoing HTTP/1.1
Host: api.qvalia.com
Accept: */*

{
  "status": "success",
  "data": [
    {}
  ]
}
  • GETGet incoming credit notes
  • POSTPost incoming credit note
  • GETGet incoming read credit notes
  • GETGet outgoing credit notes
  • POSTPost outgoing credit note

Get incoming credit notes

get

APIs related to credit note handing

Path parameters
accountRegNoStringOptionalDefault: ""
Query parameters
limitStringOptionalDefault: ""
includeReadStringOptionalDefault: ""
offsetStringOptionalDefault: ""
documentIdStringOptionalDefault: ""
fromStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""
toStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""
updatedAtFromStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""
updatedAtToStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""
integrationIdStringOptionalDefault: ""
Header parameters
AuthorizationstringOptionalDefault: ""
AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""
Responses
200Success
application/json
204
No content
application/json
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
500Error
application/json
get
GET /{accountRegNo}/creditNotes/incoming HTTP/1.1
Host: api.qvalia.comtransaction
Accept: */*

{
  "status": "success",
  "data": [
    {}
  ]
}

Post incoming credit note

post

APIs related to credit note handing

Path parameters
accountRegNoStringOptionalDefault: ""
Header parameters
AuthorizationstringOptionalDefault: ""
Content-TypeStringOptionalDefault: ""
AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""
Body
CreditNoteobjectOptional
Responses
200Success
application/json
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
409Error
application/json
422Error
application/json
500Error
application/json
post
POST /transaction/{accountRegNo}/creditNotes/incoming HTTP/1.1
Host: api.qvalia.com
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "CreditNote": {}
}
{
  "status": "success",
  "data": {
    "message": "credit note 12335675 sent",
    "credit_note_id": "12335675"
  }
}

Post outgoing credit note

post

APIs related to credit note handing

Path parameters
accountRegNoStringOptionalDefault: ""
Header parameters
AuthorizationstringOptionalDefault: ""
Content-TypeStringOptionalDefault: ""
AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""
Body
CreditNoteobjectOptional
Responses
200Success
application/json
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
409Error
application/json
422Error
application/json
500Error
application/json
post
POST /transaction/{accountRegNo}/creditNotes/outgoing HTTP/1.1
Host: api.qvalia.com
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "CreditNote": {}
}
{
  "status": "success",
  "data": {
    "message": "credit note 12335675 sent",
    "credit_note_id": "12335675"
  }
}