DealerStatement

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getDealerStatement

post

Retrieve dealer statement information.

Authorizations

Body

Responses

200

Successful operation.

application/json

post/getDealerStatement

POST /nexum/627/2022.01/parameter/getDealerStatement HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

200

Successful operation.

{
  "DealerStatement": {
    "Adjustments": "text",
    "ChargebackAmount": "text",
    "ClosedDealerMessage1": [
      {
        "EntryId": 1,
        "ClosedDealerMessage1": "text"
      }
    ],
    "ClosedDealerMessage2": [
      {
        "EntryId": 1,
        "ClosedDealerMessage2": "text"
      }
    ],
    "DealerDormant": 1,
    "Fees": "text",
    "Format": 1,
    "HoldbackAmount": "text",
    "InquiryLine": "text",
    "InstitutionAddressLine": [
      {
        "EntryId": 1,
        "InstitutionAddressLine": "text"
      }
    ],
    "MessageLine1": [
      {
        "EntryId": 1,
        "MessageLine1": "text"
      }
    ],
    "MessageLine2": [
      {
        "EntryId": 1,
        "MessageLine2": "text"
      }
    ],
    "NegativeSignOption": 1,
    "NumberoftimesGenerated": 1,
    "PrintDatesinHeader": true,
    "PrintTransactionDates": true,
    "PrintTransactionDetail": true,
    "SeparateClosedDealer": true,
    "StatementCutoffDate": "2026-01-01",
    "StatementDates": "text",
    "StatementGroupList": "text",
    "SuppressDealerNumberZeros": true,
    "TotalDealerReserve": "text",
    "UpfrontReserve": "text",
    "UseCommas": true,
    "UseContactName": true,
    "YtdTotalPrinting": true
  }
}

getDealerStatementSelectFields

post

Retrieve select fields for dealer statement information.

Authorizations

Body

Responses

200

Successful operation.

application/json

post/getDealerStatementSelectFields

POST /nexum/627/2022.01/parameter/getDealerStatementSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 923

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "SelectableFields": {
    "IncludeAllDealerStatementFields": true,
    "DealerStatementFields": {
      "Adjustments": true,
      "ChargebackAmount": true,
      "ClosedDealerMessage1": [
        1
      ],
      "ClosedDealerMessage2": [
        1
      ],
      "DealerDormant": true,
      "Fees": true,
      "Format": true,
      "HoldbackAmount": true,
      "InquiryLine": true,
      "InstitutionAddressLine": [
        1
      ],
      "MessageLine1": [
        1
      ],
      "MessageLine2": [
        1
      ],
      "NegativeSignOption": true,
      "NumberoftimesGenerated": true,
      "PrintDatesinHeader": true,
      "PrintTransactionDates": true,
      "PrintTransactionDetail": true,
      "SeparateClosedDealer": true,
      "StatementCutoffDate": true,
      "StatementDates": true,
      "StatementGroupList": true,
      "SuppressDealerNumberZeros": true,
      "TotalDealerReserve": true,
      "UpfrontReserve": true,
      "UseCommas": true,
      "UseContactName": true,
      "YtdTotalPrinting": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}

200

Successful operation.

{
  "DealerStatement": {
    "Adjustments": "text",
    "ChargebackAmount": "text",
    "ClosedDealerMessage1": [
      {
        "EntryId": 1,
        "ClosedDealerMessage1": "text"
      }
    ],
    "ClosedDealerMessage2": [
      {
        "EntryId": 1,
        "ClosedDealerMessage2": "text"
      }
    ],
    "DealerDormant": 1,
    "Fees": "text",
    "Format": 1,
    "HoldbackAmount": "text",
    "InquiryLine": "text",
    "InstitutionAddressLine": [
      {
        "EntryId": 1,
        "InstitutionAddressLine": "text"
      }
    ],
    "MessageLine1": [
      {
        "EntryId": 1,
        "MessageLine1": "text"
      }
    ],
    "MessageLine2": [
      {
        "EntryId": 1,
        "MessageLine2": "text"
      }
    ],
    "NegativeSignOption": 1,
    "NumberoftimesGenerated": 1,
    "PrintDatesinHeader": true,
    "PrintTransactionDates": true,
    "PrintTransactionDetail": true,
    "SeparateClosedDealer": true,
    "StatementCutoffDate": "2026-01-01",
    "StatementDates": "text",
    "StatementGroupList": "text",
    "SuppressDealerNumberZeros": true,
    "TotalDealerReserve": "text",
    "UpfrontReserve": "text",
    "UseCommas": true,
    "UseContactName": true,
    "YtdTotalPrinting": true
  }
}

updateDealerStatementByID

post

Update Dealer Statement by ID

Authorizations

Body

Responses

200

Successful operation.

application/json

post/updateDealerStatementByID

POST /nexum/627/2022.01/parameter/updateDealerStatementByID HTTP/1.1
Host: naas.ymcu.libum.io
Content-Type: application/json
Accept: */*
Content-Length: 1082

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "DealerStatementUpdatableFields": {
    "Adjustments": "text",
    "ChargebackAmount": "text",
    "ClosedDealerMessage1": [
      {
        "EntryId": 1,
        "ClosedDealerMessage1": "text"
      }
    ],
    "ClosedDealerMessage2": [
      {
        "EntryId": 1,
        "ClosedDealerMessage2": "text"
      }
    ],
    "DealerDormant": 1,
    "Fees": "text",
    "Format": 1,
    "HoldbackAmount": "text",
    "InquiryLine": "text",
    "InstitutionAddressLine": [
      {
        "EntryId": 1,
        "InstitutionAddressLine": "text"
      }
    ],
    "MessageLine1": [
      {
        "EntryId": 1,
        "MessageLine1": "text"
      }
    ],
    "MessageLine2": [
      {
        "EntryId": 1,
        "MessageLine2": "text"
      }
    ],
    "NegativeSignOption": 1,
    "NumberoftimesGenerated": 1,
    "PrintDatesinHeader": true,
    "PrintTransactionDates": true,
    "PrintTransactionDetail": true,
    "SeparateClosedDealer": true,
    "StatementCutoffDate": "2026-01-01",
    "StatementDates": "text",
    "StatementGroupList": "text",
    "SuppressDealerNumberZeros": true,
    "TotalDealerReserve": "text",
    "UpfrontReserve": "text",
    "UseCommas": true,
    "UseContactName": true,
    "YtdTotalPrinting": true
  },
  "nxAttributes": {
    "customFields": {}
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}