POST api/sage200doc/so

Request Information

URI Parameters

None.

Body Parameters

Document
NameDescriptionTypeAdditional information
ClientID

globally unique identifier

None.

DBName

string

None.

Header

DocumentHdr

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientID": "bca36f4b-75ee-466c-a4a6-9510c3d2eefa",
  "DBName": "sample string 2",
  "Header": {
    "Code": "sample string 1",
    "DocDate": "2025-01-10T06:34:23.219663+02:00",
    "DocNumber": "sample string 3",
    "ExternalOrderNo": "sample string 4",
    "CustomFieldName": "sample string 5",
    "CustomFieldValue": "sample string 6",
    "DeliveryAddress": {
      "Line1": "sample string 1",
      "Line2": "sample string 2",
      "Line3": "sample string 3",
      "Line4": "sample string 4",
      "Line5": "sample string 5",
      "Line6": "sample string 6",
      "PostalCode": "sample string 7"
    },
    "Lines": [
      {
        "GLAccount": "sample string 1",
        "Warehouse": "sample string 2",
        "InvCode": "sample string 3",
        "Description": "sample string 4",
        "Quantity": 5.1,
        "UnitCost": 6.1,
        "Vatable": true
      },
      {
        "GLAccount": "sample string 1",
        "Warehouse": "sample string 2",
        "InvCode": "sample string 3",
        "Description": "sample string 4",
        "Quantity": 5.1,
        "UnitCost": 6.1,
        "Vatable": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TDB.Models.Evolution">
  <ClientID>bca36f4b-75ee-466c-a4a6-9510c3d2eefa</ClientID>
  <DBName>sample string 2</DBName>
  <Header>
    <Code>sample string 1</Code>
    <CustomFieldName>sample string 5</CustomFieldName>
    <CustomFieldValue>sample string 6</CustomFieldValue>
    <DeliveryAddress>
      <Line1>sample string 1</Line1>
      <Line2>sample string 2</Line2>
      <Line3>sample string 3</Line3>
      <Line4>sample string 4</Line4>
      <Line5>sample string 5</Line5>
      <Line6>sample string 6</Line6>
      <PostalCode>sample string 7</PostalCode>
    </DeliveryAddress>
    <DocDate>2025-01-10T06:34:23.219663+02:00</DocDate>
    <DocNumber>sample string 3</DocNumber>
    <ExternalOrderNo>sample string 4</ExternalOrderNo>
    <Lines>
      <DocumentDetail>
        <Description>sample string 4</Description>
        <GLAccount>sample string 1</GLAccount>
        <InvCode>sample string 3</InvCode>
        <Quantity>5.1</Quantity>
        <UnitCost>6.1</UnitCost>
        <Vatable>true</Vatable>
        <Warehouse>sample string 2</Warehouse>
      </DocumentDetail>
      <DocumentDetail>
        <Description>sample string 4</Description>
        <GLAccount>sample string 1</GLAccount>
        <InvCode>sample string 3</InvCode>
        <Quantity>5.1</Quantity>
        <UnitCost>6.1</UnitCost>
        <Vatable>true</Vatable>
        <Warehouse>sample string 2</Warehouse>
      </DocumentDetail>
    </Lines>
  </Header>
</Document>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResult
NameDescriptionTypeAdditional information
StatusScode

string

None.

DBName

string

None.

DocumentNo

string

None.

ExtReference

string

None.

Error

string

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusScode": "sample string 1",
  "DBName": "sample string 2",
  "DocumentNo": "sample string 3",
  "ExtReference": "sample string 4",
  "Error": "sample string 5"
}

application/xml, text/xml

Sample:
<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TDB.Models.Evolution">
  <DBName>sample string 2</DBName>
  <DocumentNo>sample string 3</DocumentNo>
  <Error>sample string 5</Error>
  <ExtReference>sample string 4</ExtReference>
  <StatusScode>sample string 1</StatusScode>
</ApiResult>