GET pxapi/Document?companyId={companyId}&databaseName={databaseName}&dummy={dummy}&data={data}

Internal methods for Visma PX, test the connection to the api

Request Information

Parameters

NameDescriptionAdditional information
companyId
No documentation available.

Define this parameter in the request URI.

databaseName
No documentation available.

Define this parameter in the request URI.

dummy
No documentation available.

Define this parameter in the request URI.

data
No documentation available.

Define this parameter in the request URI.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:
{
  "Messagetype": 1,
  "Datareference": "sample string 2",
  "Messagetext": "sample string 3",
  "Created": "sample string 4",
  "Noofrowssub1": 1,
  "Noofrowssub2": 1,
  "Noofrowssub3": 1,
  "Noofrowssub4": 1,
  "Noofrowssub5": 1,
  "Noofrowssub6": 1,
  "AutoInvoiceData": {
    "Status": 1,
    "Documentid": 2,
    "Errortext": "sample string 3",
    "Xmlfilesuffix": "sample string 4",
    "Filereference": "sample string 5",
    "Document": "QEBA",
    "Attachments": [
      {
        "Attachmenttype": 1,
        "Documentid": 2,
        "Attachmentid": 1,
        "Filereference": "sample string 3",
        "Filename": "sample string 4",
        "DceInvoice": "QEBA"
      },
      {
        "Attachmenttype": 1,
        "Documentid": 2,
        "Attachmentid": 1,
        "Filereference": "sample string 3",
        "Filename": "sample string 4",
        "DceInvoice": "QEBA"
      },
      {
        "Attachmenttype": 1,
        "Documentid": 2,
        "Attachmentid": 1,
        "Filereference": "sample string 3",
        "Filename": "sample string 4",
        "DceInvoice": "QEBA"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<Message xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Visma.PXWebApi.Domain.Entities.Misc">
  <AutoInvoiceData>
    <Attachments>
      <AutoInvoiceAttachment>
        <Attachmentid>1</Attachmentid>
        <Attachmenttype>1</Attachmenttype>
        <DceInvoice>QEBA</DceInvoice>
        <Documentid>2</Documentid>
        <Filename>sample string 4</Filename>
        <Filereference>sample string 3</Filereference>
      </AutoInvoiceAttachment>
      <AutoInvoiceAttachment>
        <Attachmentid>1</Attachmentid>
        <Attachmenttype>1</Attachmenttype>
        <DceInvoice>QEBA</DceInvoice>
        <Documentid>2</Documentid>
        <Filename>sample string 4</Filename>
        <Filereference>sample string 3</Filereference>
      </AutoInvoiceAttachment>
      <AutoInvoiceAttachment>
        <Attachmentid>1</Attachmentid>
        <Attachmenttype>1</Attachmenttype>
        <DceInvoice>QEBA</DceInvoice>
        <Documentid>2</Documentid>
        <Filename>sample string 4</Filename>
        <Filereference>sample string 3</Filereference>
      </AutoInvoiceAttachment>
    </Attachments>
    <Document>QEBA</Document>
    <Documentid>2</Documentid>
    <Errortext>sample string 3</Errortext>
    <Filereference>sample string 5</Filereference>
    <Status>1</Status>
    <Xmlfilesuffix>sample string 4</Xmlfilesuffix>
  </AutoInvoiceData>
  <Created>sample string 4</Created>
  <Datareference>sample string 2</Datareference>
  <Messagetext>sample string 3</Messagetext>
  <Messagetype>1</Messagetype>
  <Noofrowssub1>1</Noofrowssub1>
  <Noofrowssub2>1</Noofrowssub2>
  <Noofrowssub3>1</Noofrowssub3>
  <Noofrowssub4>1</Noofrowssub4>
  <Noofrowssub5>1</Noofrowssub5>
  <Noofrowssub6>1</Noofrowssub6>
</Message>