CashApp AR Schemas¶
All fields applicable to the CashApp AR (Accounts Receivable payment matching) product. CashApp's primary concern is accurate payment matching — invoice_num is required, and 22 custom matching fields are unique to this product.
For shared schemas (Currency Models, etc.) see Shared Schemas & Currency Models.
Account¶
| Field | Type | Required | Description |
|---|---|---|---|
| reference | string | Yes | Caller-defined unique identifier. |
| display_reference | string | No | Display account number. Also serves as the CashApp location-level customer identifier for payment matching. Set this to the value customers use on remittance forms. |
| name | string | Yes | Customer name. |
| billing_address.address1 | string | No | Primary billing street address line. |
| billing_address.address2 | string | No | Secondary billing address line. |
| billing_address.city | string | No | Billing city. |
| billing_address.state | string | No | Billing state / province. |
| billing_address.zip | string | No | Billing postal code. |
| parent_account_number | string | No | Groups accounts into a parent-child hierarchy. |
Document¶
Core Fields¶
Warning
invoice_num is required for CashApp AR. It must match the value customers put on their remittance forms. Omitting it or using an internal ERP key will cause payment matching failures.
| Field | Type | Required | Description |
|---|---|---|---|
| account_number | string | Yes | Account this document belongs to. |
| invoice_num | string | Yes | Display invoice number. Required for CashApp AR. Must match the value on customer remittance forms — this is the key used by the payment matching engine. |
| applies_to_invoice | string | Conditional | Required when document_type is credit_note. |
| invoice_date | date (ISO 8601) | Yes | Document issue date. |
| po_number | string | No | Purchase order number. |
| discount_date | date | No | Early-payment discount expiry date. |
| discount_amount | string | No | Early-payment discount amount. Required for discount auto-deduction identification. |
| freight_amount | string | No | Amount associated with freight. Required for freight auto-deduction identification. CashApp calculates invoice amount minus this value and exports it back to you. |
| tax_amount | string | No | Amount associated with tax. Required for tax auto-deduction identification. CashApp calculates invoice amount minus this value and exports it back to you. |
| statement_number | string | No | Statement identifier grouping related invoices. Required for statement-based Auto Multi Select in CashApp. |
| statement_amount | string | No | Total open amount for the associated statement invoices. |
Custom Matching Fields¶
CashApp supports up to 22 custom values to assist with payment matching. Two accept monetary amounts; the remaining 20 accept strings.
| Field | Type | Description |
|---|---|---|
| custom_money1 | denomination | Caller-defined monetary amount (follows currency model) |
| custom_money2 | denomination | Second caller-defined monetary amount |
| custom_field1 | string | CashApp custom field 1 |
| custom_field2 | string | CashApp custom field 2 |
| custom_field3 | string | CashApp custom field 3 |
| custom_field4 | string | CashApp custom field 4 |
| custom_field5 | string | CashApp custom field 5 |
| custom_field6 | string | CashApp custom field 6 |
| custom_field7 | string | CashApp custom field 7 |
| custom_field8 | string | CashApp custom field 8 |
| custom_field9 | string | CashApp custom field 9 |
| custom_field10 | string | CashApp custom field 10 |
| custom_field11 | string | CashApp custom field 11 |
| custom_field12 | string | CashApp custom field 12 |
| custom_field13 | string | CashApp custom field 13 |
| custom_field14 | string | CashApp custom field 14 |
| custom_field15 | string | CashApp custom field 15 |
| custom_field16 | string | CashApp custom field 16 |
| custom_field17 | string | CashApp custom field 17 |
| custom_field18 | string | CashApp custom field 18 |
| custom_field19 | string | CashApp custom field 19 |
| custom_field20 | string | CashApp custom field 20 |
Financial Fields — Basic Currency Model¶
All three fields must be provided together.
| Field | Type | Required | Description |
|---|---|---|---|
| currency | ISO 4217 | Conditional* | ISO 4217 currency code. *All three Basic fields must be provided together. |
| original_denomination | denomination | Conditional* | Original gross amount. Does not change when partially paid. |
| denomination | denomination | Conditional* | Current open balance. When 0, document is automatically closed. |
Closure¶
| Field | Type | Required | Description |
|---|---|---|---|
| closure_reason | string | Yes | One of: paid, write_off, contra, adjustment, other |
| closure_date | date (ISO 8601) | No | Date of closure. Defaults to current date if absent. |
| notes | string | No | Free-text notes on the closure. |