Send billing response

Creates a SubmitBillingResponse business transaction from a metadata structure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The buyer issues a billing response to inform the seller of the invoice or credit note processing status.This is especially useful in cases where the seller might be required to provide more information.

It also facilitates automatic document processing because the following action can be initiated immediately after the response is received.

⚠️

To successfully send in a document, the sender.identifier must have an ISO identifier corresponding to the company logged in and issuing the document.

Either you were provided with the ISO identifier (Business participant identifiers) or have it attached to your credentials here.

More information (click to expand)

Due to limitations of this documentation platform, to successfully create a document, you must fill in parameters in the request Body Params below (you must be logged in to see your identifiers):

  • You must replace {{selfIdentifier}} in node sender.identifier with value 0196:1111118899 (or one corresponding to the logged in sender).
  • You must replace {{otherIdentifier}} nodes in messageHandling.receiverIdentifier and receiver.identifier with value 0196:2222228899 or a value corresponding to the receiver of the document.
  • You can also replace {{selfName}} (SenderIssuer Company) and {{otherName}} (Receiver Company) where applicable.

The following example contains the minimum JSON body required to create a valid billing response. These elements are mandatory.

{
  "messageHandling": {
    "receiverIdentifier": "0196:2222228899",
    "fallbackEmailAddress": "[email protected]"
  },
  "invoiceResponse": {
    "responseNo": "INR1234",
    "issueDate": "2019-11-06",
    "status": "MessageAcknowledgement",
    "sender": {
      "name": "Test Party One",
      "identifier": "0196:1111118899"
    },
    "receiver": {
      "name": "Test Party Two",
      "identifier": "0196:2222228899"
    },
    "documentReference": {
      "documentNo": "INV1234",
      "documentType": "Invoice"
    }
  }
}

It's also possible to add the optional message identifier for the responding invoice/credit note and then skip adding sender/receiver and document reference.

If the optional original message identifier is specified then it will overwrite the information specified about sender/receiver and document reference in metadata.

The request body schema includes all mandatory and optional elements.

For more information about allowed values for metadata elements, see Metadata.

Query Params
uuid
required

The identifier of the message in the format of a valid Universally unique identifier (GUID).

string

The identifier of the conversation.
Used as a correlation identifier between different documents in the same business context, for example, between a credit note that was issued based on an invoice and that invoice.

If not provided, it is generated automatically.
In that case, it includes the date when the message was sent, a random token, and the ISO identifier of the sender.

string
enum

The way the transaction is processed.

Allowed:
services
array of strings

A list of services that the user specifies for additional message processing.

services
uuid

An optional original message guid that can be used instead of filling in information about sender/receiver and the original document references

Body Params

Metadata structure for creating a SubmitBillingResponse business transaction.

messageHandling
object
required

Message delivery information.

invoiceResponse
object
required

The metadata structure of a billing response.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/xml