Skip to main content
POST
/
v1
/
remittances
/
{remittance_id}
Update A Remittance
curl --request POST \
  --url http://api.stuut.ai/v1/remittances/{remittance_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allocations": [
    {
      "amount_paid": 2,
      "invoice": "<string>"
    }
  ],
  "currency": "<string>",
  "partner": "<string>",
  "transaction_amount": 1,
  "transaction_date": "2023-12-25",
  "transaction_number": "<string>"
}
'
{
  "object": "<string>",
  "id": "<string>",
  "agent_confidence_reason": "<string>",
  "agent_confidence_score": 123,
  "agent_error_code": "<string>",
  "agent_uncertainties": [
    "<string>"
  ],
  "allocations": [
    {
      "invoice_number": "<string>",
      "object": "<string>",
      "remittance_id": "<string>",
      "amount_discount": 123,
      "amount_paid": 123,
      "amount_withheld": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "invoice": {
        "amount_due": 123,
        "currency": "<string>",
        "id": "<string>",
        "amount_paid": 123,
        "due_date": "2023-11-07T05:31:56Z"
      },
      "invoice_id": "<string>",
      "modified_at": "2023-11-07T05:31:56Z"
    }
  ],
  "attachment": {
    "file_type": "audio",
    "mime_type": "<string>",
    "name": "<string>",
    "object": "<string>",
    "organization_id": "<string>",
    "id": "<string>",
    "content_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "disposition": "<string>",
    "is_verified": true,
    "modified_at": "2023-11-07T05:31:56Z",
    "presigned_url": "<string>",
    "presigned_url_expires_at": "2023-11-07T05:31:56Z",
    "purpose": "<string>",
    "remote_id": "<string>",
    "size": 123,
    "src": "<unknown>",
    "user_id": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "ADP",
  "email": {
    "object": "<string>",
    "thread_id": "<string>",
    "id": "<string>",
    "attachments": [
      {
        "file_type": "audio",
        "mime_type": "<string>",
        "name": "<string>",
        "object": "<string>",
        "organization_id": "<string>",
        "id": "<string>",
        "content_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "disposition": "<string>",
        "is_verified": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "presigned_url": "<string>",
        "presigned_url_expires_at": "2023-11-07T05:31:56Z",
        "purpose": "<string>",
        "remote_id": "<string>",
        "size": 123,
        "src": "<unknown>",
        "user_id": "<string>"
      }
    ],
    "author": {
      "email": "<string>",
      "family_name": "<string>",
      "given_name": "<string>",
      "object": "<string>",
      "organization_id": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "dashboard_settings": {
        "thread_emails_sort_order": "asc"
      },
      "default_email_sender_id": "<string>",
      "invited_by_user_id": "<string>",
      "is_access_approved": true,
      "is_org_admin": true,
      "modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "onboarding_required": true,
      "profile_picture": "<string>",
      "selected": true
    },
    "author_id": "<string>",
    "bcc": [
      "<string>"
    ],
    "body": "<string>",
    "bounced_addresses": [
      "<string>"
    ],
    "bulk_email_request_id": "<string>",
    "cc": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "custom_headers": "<unknown>",
    "direction": "inbound",
    "email_reason": "<string>",
    "email_sender": {
      "email": "<string>",
      "object": "<string>",
      "reply_to": "<string>",
      "user_id": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "expired_at": "2023-11-07T05:31:56Z",
      "is_nylas_connection": true,
      "is_nylas_grant_expired": true,
      "is_shared": true,
      "modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "provider": "<string>",
      "reply_to_name": "<string>",
      "signature_html": "<string>"
    },
    "email_sender_id": "<string>",
    "error_message": "<string>",
    "from_email": "<string>",
    "generated_body": "<string>",
    "is_automated": true,
    "is_generated": true,
    "is_originated_in_stuut": true,
    "is_unread": true,
    "modified_at": "2023-11-07T05:31:56Z",
    "parent_email_id": "<string>",
    "participants": [
      "jsmith@example.com"
    ],
    "remote_id": "<string>",
    "remote_links": [
      {
        "email_id": "<string>",
        "email_sender_id": "<string>",
        "object": "<string>",
        "remote_id": "<string>",
        "remote_thread_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z"
      }
    ],
    "reply_to": [
      "<string>"
    ],
    "send_separately": true,
    "sent_at": "2023-11-07T05:31:56Z",
    "sent_by_id": "<string>",
    "snippet": "<string>",
    "status": "draft",
    "subject": "<string>",
    "to": [
      "<string>"
    ]
  },
  "modified_at": "2023-11-07T05:31:56Z",
  "partner": {
    "id": "<string>",
    "account_number": "<string>",
    "ap_portals": [
      {
        "object": "<string>",
        "partner_id": "<string>",
        "id": "<string>",
        "account": {
          "object": "<string>",
          "organization_id": "<string>",
          "provider": "coupa",
          "id": "<string>",
          "available_operations": "<unknown>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z"
        },
        "account_id": "<string>",
        "account_key": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "customer_identifier": "<string>",
        "customer_name": "<string>",
        "invoice_submission_guidelines": "<string>",
        "is_enabled": true,
        "is_invoice_submission_enabled": true,
        "is_report_download_enabled": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "provider": "coupa",
        "report_email": "<string>",
        "report_frequency": "daily"
      }
    ],
    "assignee": {
      "email": "<string>",
      "family_name": "<string>",
      "given_name": "<string>",
      "object": "<string>",
      "organization_id": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "dashboard_settings": {
        "thread_emails_sort_order": "asc"
      },
      "default_email_sender_id": "<string>",
      "invited_by_user_id": "<string>",
      "is_access_approved": true,
      "is_org_admin": true,
      "modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "onboarding_required": true,
      "profile_picture": "<string>",
      "selected": true
    },
    "assignee_id": "<string>",
    "billing_address": {
      "object": "<string>",
      "city": "<string>",
      "coordinates": {},
      "country": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "phone": "<string>",
      "postal_code": "<string>",
      "remote_id": "<string>",
      "state": "<string>",
      "type": "<string>"
    },
    "billing_address_id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "currency": "ADP",
    "custom_fields": "<unknown>",
    "description": "<string>",
    "email": "<string>",
    "family_name": "<string>",
    "finix_identity_id": "<string>",
    "given_name": "<string>",
    "invoice_prefix": "<string>",
    "is_active": true,
    "is_company": true,
    "is_email_disabled": true,
    "is_phone_disabled": true,
    "is_primary_email": true,
    "is_primary_phone": true,
    "last_outreach_at": "2023-11-07T05:31:56Z",
    "last_outreach_channel": "email",
    "last_outreach_to": "<string>",
    "last_synced_at": "2023-11-07T05:31:56Z",
    "legal_name": "<string>",
    "modified_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "object": "<string>",
    "on_behalf_of": "<string>",
    "on_behalf_of_phone": "<string>",
    "organization_id": "<string>",
    "parent_id": "<string>",
    "phone": "<string>",
    "remote_created_at": "2023-11-07T05:31:56Z",
    "remote_id": "<string>",
    "remote_metadata": null,
    "remote_modified_at": "2023-11-07T05:31:56Z",
    "remote_parent_id": "<string>",
    "remote_payment_portal_url": "<string>",
    "shipping_address": {
      "object": "<string>",
      "city": "<string>",
      "coordinates": {},
      "country": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "modified_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "phone": "<string>",
      "postal_code": "<string>",
      "remote_id": "<string>",
      "state": "<string>",
      "type": "<string>"
    },
    "status_metadata": "<unknown>",
    "sync_status": "partial",
    "tags": [
      {
        "object": "<string>",
        "partner_id": "<string>",
        "tag_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "is_manual": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "tag": {
          "name": "<string>",
          "object": "<string>",
          "id": "<string>",
          "color": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "rule_condition": {}
        }
      }
    ],
    "tax_number": "<string>",
    "timezone": "Africa/Abidjan"
  },
  "payee_bank_details": {
    "account_number": null,
    "bank_name": null,
    "bank_number": null,
    "branch_number": null,
    "iban": null,
    "type": null
  },
  "payer_bank_details": {
    "account_number": null,
    "bank_name": null,
    "bank_number": null,
    "branch_number": null,
    "iban": null,
    "type": null
  },
  "payer_email": "<string>",
  "payer_name": "<string>",
  "payment_method": "<string>",
  "status": "submitted",
  "transaction_amount": 123,
  "transaction_date": "2023-12-25",
  "transaction_number": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
remittance_id
string
required

Body

application/json
​
allocations
object[]

Invoice allocations. You must provide all invoices during an update. If this value is not provided, allocations will not change.

​
currency
string

ISO 4217 currency code of the transaction.

Maximum string length: 3
​
partner
string

The id of the partner this remittance originated from.

​
transaction_amount
integer

The total amount of the remittance in the currency's smallest unit, e.g. $10 USD -> 1000

Required range: x >= 0
​
transaction_date
string<date>

The date the transaction was made or expected to be received.

​
transaction_number
string

The bank transaction number that was provided in this remittance.

Response

Successful response

​
object
string
required
​
id
string
Maximum string length: 32
​
agent_confidence_reason
string | null

The justification for the agent's confidence score.

​
agent_confidence_score
integer | null

The confidence score of the result on a scale of 0-100, where 0 indicates no confidence in the accuracy of the result and 100 indicates full confidence in the accuracy of the result.

​
agent_error_code
string | null

The code for why an error occurred when processing the statement.

​
agent_uncertainties
string[]

A list of uncertainties we have regarding the result.

​
allocations
object[]
​
attachment
object
​
created_at
string<date-time>
​
currency
enum<string> | null

ISO 4217 currency code of the transaction.

Available options:
ADP,
AED,
AFA,
AFN,
ALK,
ALL,
AMD,
ANG,
AOA,
AOK,
AON,
AOR,
ARA,
ARL,
ARM,
ARP,
ARS,
ATS,
AUD,
AWG,
AZM,
AZN,
BAD,
BAM,
BAN,
BBD,
BDT,
BEC,
BEF,
BEL,
BGL,
BGM,
BGN,
BGO,
BHD,
BIF,
BMD,
BND,
BOB,
BOL,
BOP,
BOV,
BRB,
BRC,
BRE,
BRL,
BRN,
BRR,
BRZ,
BSD,
BTN,
BUK,
BWP,
BYB,
BYN,
BYR,
BZD,
CAD,
CDF,
CHE,
CHF,
CHW,
CLE,
CLF,
CLP,
CNH,
CNX,
CNY,
COP,
COU,
CRC,
CSD,
CSK,
CUC,
CUP,
CVE,
CYP,
CZK,
DDM,
DEM,
DJF,
DKK,
DOP,
DZD,
ECS,
ECV,
EEK,
EGP,
ERN,
ESA,
ESB,
ESP,
ETB,
EUR,
FIM,
FJD,
FKP,
FRF,
GBP,
GEK,
GEL,
GHC,
GHS,
GIP,
GMD,
GNF,
GNS,
GQE,
GRD,
GTQ,
GWE,
GWP,
GYD,
HKD,
HNL,
HRD,
HRK,
HTG,
HUF,
IDR,
IEP,
ILP,
ILR,
ILS,
INR,
IQD,
IRR,
ISJ,
ISK,
ITL,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRH,
KRO,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LTL,
LTT,
LUC,
LUF,
LUL,
LVL,
LVR,
LYD,
MAD,
MAF,
MCF,
MDC,
MDL,
MGA,
MGF,
MKD,
MKN,
MLF,
MMK,
MNT,
MOP,
MRO,
MRU,
MTL,
MTP,
MUR,
MVP,
MVR,
MWK,
MXN,
MXP,
MXV,
MYR,
MZE,
MZM,
MZN,
NAD,
NGN,
NIC,
NIO,
NLG,
NOK,
NPR,
NZD,
OMR,
PAB,
PEI,
PEN,
PES,
PGK,
PHP,
PKR,
PLN,
PLZ,
PTE,
PYG,
QAR,
RHD,
ROL,
RON,
RSD,
RUB,
RUR,
RWF,
SAR,
SBD,
SCR,
SDD,
SDG,
SDP,
SEK,
SGD,
SHP,
SIT,
SKK,
SLE,
SLL,
SOS,
SRD,
SRG,
SSP,
STD,
STN,
SUR,
SVC,
SYP,
SZL,
THB,
TJR,
TJS,
TMM,
TMT,
TND,
TOP,
TPE,
TRL,
TRY,
TTD,
TWD,
TZS,
UAH,
UAK,
UGS,
UGX,
USD,
USN,
USS,
UYI,
UYP,
UYU,
UYW,
UZS,
VEB,
VED,
VEF,
VES,
VND,
VNN,
VUV,
WST,
XAF,
XAG,
XAU,
XBA,
XBB,
XBC,
XBD,
XCD,
XCG,
XDR,
XEU,
XFO,
XFU,
XOF,
XPD,
XPF,
XPT,
XRE,
XSU,
XTS,
XUA,
XXX,
YDD,
YER,
YUD,
YUM,
YUN,
YUR,
ZAL,
ZAR,
ZMK,
ZMW,
ZRN,
ZRZ,
ZWD,
ZWL,
ZWR,
null
Maximum string length: 3
​
email
object
​
modified_at
string<date-time> | null
​
partner
object
​
payee_bank_details
object
​
payer_bank_details
object
​
payer_email
string | null

The email of the payer for this remittance.

​
payer_name
string | null

The name of the payer for this remittance.

​
payment_method
string | null

The payment method used to make the payment.

​
status
enum<string>

The status of this remittance advice.

Available options:
submitted,
processing,
invalid,
pending_approval,
approved
Maximum string length: 16
​
transaction_amount
integer

The total amount of the remittance in the currency's smallest unit, e.g. $10 USD -> 1000

​
transaction_date
string<date> | null

The date the transaction was made or expected to be received.

​
transaction_number
string | null

The bank transaction number that was provided in this remittance.