# RemittanceService
Manage remittance records.


**Symitar eDocs References:** Coming soon.

## Operations

### getRemittance

POST `/nexum/{sym}/2022.01/remittance/getRemittance`



[OpenAPI source, including all nested schema definitions](/docs/nexum/openapi/v2022.01-remittance.yaml)

#### Authorization

bearerAuth

- **sym** (path, string, required): Sym number

#### Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| Credentials | object | Yes | The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters. |
| RemittanceGlobalSequenceDate | string · date | No | The remittance global sequence date. |
| RemittanceGlobalSequence | integer | No | The remittance global sequence number. |
| nxAttributes | object | No | The custom object for NexumAPI request attributes. |

```json
{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceGlobalSequenceDate": "string",
  "RemittanceGlobalSequence": 0,
  "nxAttributes": {
    "customFields": {}
  }
}
```

#### Response 200

Successful operation.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| Remittance | object | No | The remittance object. |

```json
{
  "Remittance": {
    "Amount": 0,
    "ConfirmationNumber": "string",
    "ConfirmationSeq": 0,
    "ConsoleNumber": 0,
    "Description": "string",
    "FundType": 0,
    "GlCode": 0,
    "GlobalSequence": 0,
    "GlobalSequenceDate": "string",
    "MemberAccount": "string",
    "Payer": 0,
    "PostDate": "string",
    "PrevDueDate": "string",
    "ProcessorAcct": "string",
    "ProcessorCode": 0,
    "ReconDate": "string",
    "RecordChangeDate": "string",
    "RemitDate": "string",
    "Sequence": 0,
    "Status": 0
  }
}
```

### getRemittanceSelectFields

POST `/nexum/{sym}/2022.01/remittance/getRemittanceSelectFields`



[OpenAPI source, including all nested schema definitions](/docs/nexum/openapi/v2022.01-remittance.yaml)

#### Authorization

bearerAuth

- **sym** (path, string, required): Sym number

#### Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| Credentials | object | Yes | The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters. |
| RemittanceGlobalSequenceDate | string · date | No | The remittance global sequence date. |
| RemittanceGlobalSequence | integer | No | The remittance global sequence number. |
| SelectableFields | object | No | Fields that can be selected on the Remittance record. |
| nxAttributes | object | No | The custom object for NexumAPI request attributes. |

```json
{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceGlobalSequenceDate": "string",
  "RemittanceGlobalSequence": 0,
  "SelectableFields": {
    "IncludeAllRemittanceFields": true,
    "RemittanceFields": {
      "Amount": true,
      "ConfirmationNumber": true,
      "ConfirmationSeq": true,
      "ConsoleNumber": true,
      "Description": true,
      "FundType": true,
      "GlCode": true,
      "GlobalSequence": true,
      "GlobalSequenceDate": true,
      "MemberAccount": true,
      "Payer": true,
      "PostDate": true,
      "PrevDueDate": true,
      "ProcessorAcct": true,
      "ProcessorCode": true,
      "ReconDate": true,
      "RecordChangeDate": true,
      "RemitDate": true,
      "Sequence": true,
      "Status": true
    }
  },
  "nxAttributes": {
    "customFields": {}
  }
}
```

#### Response 200

Successful operation.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| Remittance | object | No | The remittance object. |

```json
{
  "Remittance": {
    "Amount": 0,
    "ConfirmationNumber": "string",
    "ConfirmationSeq": 0,
    "ConsoleNumber": 0,
    "Description": "string",
    "FundType": 0,
    "GlCode": 0,
    "GlobalSequence": 0,
    "GlobalSequenceDate": "string",
    "MemberAccount": "string",
    "Payer": 0,
    "PostDate": "string",
    "PrevDueDate": "string",
    "ProcessorAcct": "string",
    "ProcessorCode": 0,
    "ReconDate": "string",
    "RecordChangeDate": "string",
    "RemitDate": "string",
    "Sequence": 0,
    "Status": 0
  }
}
```

### updateRemittanceByID

POST `/nexum/{sym}/2022.01/remittance/updateRemittanceByID`



[OpenAPI source, including all nested schema definitions](/docs/nexum/openapi/v2022.01-remittance.yaml)

#### Authorization

bearerAuth

- **sym** (path, string, required): Sym number

#### Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| Credentials | object | Yes | The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters. |
| RemittanceGlobalSequenceDate | string · date | No | The remittance global sequence date. |
| RemittanceGlobalSequence | integer | No | The remittance global sequence number. |
| RemittanceUpdatableFields | object | No | Object of remittance fields that can be updated. |
| nxAttributes | object | No | The custom object for NexumAPI request attributes. |

```json
{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceGlobalSequenceDate": "string",
  "RemittanceGlobalSequence": 0,
  "RemittanceUpdatableFields": {
    "Amount": 0,
    "ConfirmationSeq": 0,
    "ConsoleNumber": 0,
    "Description": "string",
    "FundType": 0,
    "GlCode": 0,
    "MemberAccount": "string",
    "Payer": 0,
    "PostDate": "string",
    "PrevDueDate": "string",
    "ProcessorAcct": "string",
    "ProcessorCode": 0,
    "ReconDate": "string",
    "RemitDate": "string",
    "Sequence": 0,
    "Status": 0,
    "TranCode": "string",
    "TranType": 0,
    "User": 0,
    "VoidDate": "string"
  },
  "nxAttributes": {
    "customFields": {}
  }
}
```

#### Response 200

Successful operation.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| UpdateStatus | object | No |  |

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

### createRemittance

POST `/nexum/{sym}/2022.01/remittance/createRemittance`



[OpenAPI source, including all nested schema definitions](/docs/nexum/openapi/v2022.01-remittance.yaml)

#### Authorization

bearerAuth

- **sym** (path, string, required): Sym number

#### Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| Credentials | object | Yes | The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters. |
| RemittanceCreatableFields | object | Yes | Object of remittance fields that can be created. |
| nxAttributes | object | No | The custom object for NexumAPI request attributes. |

```json
{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceCreatableFields": {
    "Amount": "string",
    "Description": "string",
    "MemberAccount": "0",
    "ProcessorAcct": "0",
    "Status": 0,
    "TranType": 0,
    "FundType": 0
  }
}
```

#### Response 200

Successful operation.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| RemittanceCompositeKey | object | No |  |

```json
{
  "RemittanceCompositeKey": {
    "RemittanceGlobalSequenceDate": "string",
    "RemittanceGlobalSequence": 0
  }
}
```

### deleteRemittance

POST `/nexum/{sym}/2022.01/remittance/deleteRemittance`



[OpenAPI source, including all nested schema definitions](/docs/nexum/openapi/v2022.01-remittance.yaml)

#### Authorization

bearerAuth

- **sym** (path, string, required): Sym number

#### Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| Credentials | object | Yes | The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters. |
| RemittanceGlobalSequenceDate | string · date | No | The remittance global sequence date. |
| RemittanceGlobalSequence | integer | No | The remittance global sequence number. |
| nxAttributes | object | No | The custom object for NexumAPI request attributes. |

```json
{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "RemittanceGlobalSequenceDate": "string",
  "RemittanceGlobalSequence": 0,
  "nxAttributes": {
    "customFields": {}
  }
}
```

#### Response 200

Successful operation.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| nxAttributes | object | No | The custom object for NexumAPI response attributes. |

```json
{
  "nxAttributes": {}
}
```